Add configuration file instructions
authorMark Cooper <mark.c.cooper@outlook.com>
Wed, 12 Mar 2014 17:19:43 +0000 (10:19 -0700)
committerMark Cooper <mark.c.cooper@outlook.com>
Wed, 12 Mar 2014 17:19:43 +0000 (10:19 -0700)
README

diff --git a/README b/README
index d7b25a4..2d3a025 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,35 @@
+iNCIPit
+=======
+
 Inital version of ncip v.1 ncip responder for evergreen / open-ils
 
-you can initiate / test with the following :
+Initial configuration
+---------------------
 
-curl -v --insecure -H 'Content-Type:text/xml' --data @NCIPmsgs/LookupUser.ncip -X POST 'https://target.host/iNCIPit.cgi'
+Setup the default configuration file:
+
+```
+cp iNCIPit-example.ini iNCIPit.ini # edit as necessary
+```
+
+Optionally, per request hostname configuration files can be used. For example:
 
-(--insecure argument only necessary if you test a target.host lacking a valid cert) 
+- https://target.host/iNCIPit.cgi # REQUEST URL
+- target.host # HOSTNAME
+- target.host.ini # CONFIGURATION FILE
 
+```
+cp iNCIPit-example.ini target.host.ini # edit as necessary
+```
+
+Testing
+-------
+
+you can initiate / test with the following:
+
+```
+curl -v --insecure -H 'Content-Type:text/xml' --data @NCIPmsgs/LookupUser.ncip -X POST 'https://target.host/iNCIPit.cgi'
+# (--insecure argument only necessary if you test a target.host lacking a valid cert) 
+```
 
+---