From 2d12d9fe0291a85daed3390d42112606c6261a6f Mon Sep 17 00:00:00 2001
From: Keith Armstrong <keith@belkast.com>
Date: Tue, 7 Jan 2025 15:43:49 -0500
Subject: [PATCH] Added description of new functionality

---
 README.md | 45 ++++++++++++++++++++++++++++++++++-----------
 1 file changed, 34 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index a8962d8..c39d134 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,13 @@ soapClient.jar allows you to send data to a SOAP service using an XML template f
 <li>SOAP Service URL</li>
 <li>SOAP Service Username</li>
 <li>SOAP Service Password</li>
-<li>XML Template file</li>
-<li>CSV Input File</li>
+<li>Does SOAP Service require authentication</li>
 <li>Whether to use SSL</li>
 <li>Java Keystore</li>
 <li>Java Keystore Password</li>
-<li>Whether to allow empty values</li>
+<li>XML Template file</li>
+<li>CSV Input File</li>
+<li>Are empty CSV values allowed</li>
 </ul>
 
 ## Command line parameters
@@ -28,7 +29,7 @@ This is the value to encrypt using the encryption key. You need to pass both <i>
 This is the location of the properties file to be consumed by the program.
 
 ### --debug
-This is a true/false flag which specifies if the debug information is displayed on the screen. The debug information is <b>always</b> written to the <i>debug.log</i> file.
+This parameter takes no value and, if present, displays debug information on the screen. The debug information is <b>always</b> written to the debug.log file.
 
 ## Helper scripts
 
@@ -69,14 +70,34 @@ This is the main file containing the settings used by the program, and one with
 
 ```toml
 SHIM_URL = https://test.mycompany.com:8443/IDMProv/role/service
-PASSWORD = PT9TKHwFgJCxATJtAAMtMwtIF0UjFal6fo5riBN+ExY=
 USERNAME = cn=keitha,ou=active,ou=users,o=belkast
-XML_FILE = USER_TO_ROLE.xml
-CSV_FILE = msalah.csv
-CSV_ALLOW_EMPTY_COLUMN_VALUES = true
+PASSWORD = PT9TKHwFgJCxATJtAAMtMwtIF0UjFal6fo5riBN+ExY=
+AUTH_REQUIRED = true
 SSL = true 
 JAVA_KS_LOCATION = ldap.keystore
 JAVA_KS_PASSWORD = changeit
+XML_FILE = USER_TO_ROLE.xml
+CSV_FILE = msalah.csv
+CSV_ALLOW_EMPTY_COLUMN_VALUES = true
+```
+
+### Default values
+
+The settings listed below are not required to be included in the configuration file. If not present, they will be assigned the default values shown below.
+
+<ul>
+   <li>AUTH_REQUIRED : true</li>
+   <li>SSL : true</li>
+   <li>CSV_ALLOW_EMPTY_COLUMN_VALUES : false</li>
+</ul>
+
+### Username and Password
+
+If the configuration file specifies that authentication to the SOAP Service is required, and either the USERNAME or PASSWORD is not specified, you will be asked to enter the missing values.
+
+```zsh
+Please enter your username : jimbo
+Please enter your password : Password123
 ```
 
 ### XML template file
@@ -207,13 +228,15 @@ If you run the <i>linux_runner.sh</i> bash script with no command line parameter
 Usage: <main class> [options]
   Options:
     --debug
-      Display debug information on the screen (true/false)
+      Display debug information on the screen (no value required)
+      Default: false
     --encrypt
-      Value to encrypt using the Encryption Key
+      Value to encrypt using the encryption key
   * --key
-      Encryption Key (must be 16 characters in length)
+      Encryption key (must be 16 characters)
     --props
       Location of the properties file
+      Default: props.conf
 ```
 
 ### With command line parameters