make the links into hyperlinks
authorMatthew Vernon <mcv21@cam.ac.uk>
Tue, 22 Jul 2014 16:27:56 +0000 (17:27 +0100)
committerMatthew Vernon <mcv21@cam.ac.uk>
Tue, 22 Jul 2014 16:27:56 +0000 (17:27 +0100)
README.md

index 3ab24d8..fb4d8a3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,9 +8,9 @@ files that provide a Classic ASP/VBScript implementation of a 'Raven'
 authentication module; Raven is the web authentication protocol used
 by the University of Cambridge, UK. The logic and code of the
 'Ucam_Webauth' class are loosely based on the PHP Raven authentication
-class provided at http://raven.cam.ac.uk/project/.
+class provided at [http://raven.cam.ac.uk/project/](http://raven.cam.ac.uk/project/).
 - For a full description of the latest Raven specification and an explanation 
-of how Raven works, go to http://raven.cam.ac.uk/project/.
+of how Raven works, go to [http://raven.cam.ac.uk/project/](http://raven.cam.ac.uk/project/).
 - This software was originally created for the Careers Service,
 University of Cambridge by sh801@cam.ac.uk. For support, please
 contact raven-support@ucs.cam.ac.uk
@@ -35,22 +35,25 @@ This module has been tested on IIS7 with .NET Framework set to
 Installation
 ------------
 ### Cryptographic functions
-Cryptographic functions are provided by the Javascript libraries within the 
-'js' folder. These libraries are versions of the client-side Javascript 
-libraries provided at http://kjur.github.io/jsrsasign/index.html 
-but modified to run server-side. There is no need to install any 
+Cryptographic functions are provided by the Javascript libraries
+within the 'js' folder. These libraries are versions of the
+client-side Javascript libraries provided at
+[http://kjur.github.io/jsrsasign/index.html](http://kjur.github.io/jsrsasign/index.html)
+but modified to run server-side. There is no need to install any
 additional cryptography libraries.
 
 ### Install Raven certificates
-The authentication module uses the Raven public key certificate at 
-https://raven.cam.ac.uk/project/keys/ to verify authentication responses. 
-Download the certificate from https://raven.cam.ac.uk/project/keys/ and copy 
-to the 'certificates' folder provided with this authentication module 
-download - the 'certificates' folder is a temporary location for the 
-certificate while you get the module up and running. You will need to supply 
-the full path to the 'certificates' folder as either a 'key_dir' argument 
-to the 'Ucam_Webauth' constructor or by modifying the 'Ucam_Webauth' 
-variable 'DEFAULT_KEY_DIR' directly. 
+The authentication module uses the Raven public key certificate at
+[https://raven.cam.ac.uk/project/keys/](https://raven.cam.ac.uk/project/keys/)
+to verify authentication responses.  Download the certificate from
+[https://raven.cam.ac.uk/project/keys/](https://raven.cam.ac.uk/project/keys/)
+and copy to the 'certificates' folder provided with this
+authentication module download - the 'certificates' folder is a
+temporary location for the certificate while you get the module up and
+running. You will need to supply the full path to the 'certificates'
+folder as either a 'key_dir' argument to the 'Ucam_Webauth'
+constructor or by modifying the 'Ucam_Webauth' variable
+'DEFAULT_KEY_DIR' directly.
 
 Once you have everything working, move the 'certificates' folder 
 to a new location on your webserver that is not web- or publicly-accessible 
@@ -59,11 +62,12 @@ and modify the 'key_dir' string accordingly.
 - NOTE: you may have to change the name of the key file from 'pubkey2.crt' 
 to '2.crt'. 
 
-If you're using the Raven test server 
-(http://raven.cam.ac.uk/project/test-demo/) for testing purposes, make sure 
-you install the test server keys instead, but ensure you remove these keys 
-before using the authentication module in a production environment, as 
-recommended by the demo Raven server:
+If you're using the Raven test server
+([http://raven.cam.ac.uk/project/test-demo/](http://raven.cam.ac.uk/project/test-demo/))
+for testing purposes, make sure you install the test server keys
+instead, but ensure you remove these keys before using the
+authentication module in a production environment, as recommended by
+the demo Raven server:
 
 > It is vital to keep these demo keys seperate from keys 
 > used with a production service - failure to do so could