diff --git a/README.md b/README.md
index 45984a1..a186a7a 100644
--- a/README.md
+++ b/README.md
@@ -61,7 +61,8 @@ I use IDEA IntelliJ Community Ediiton when writing JAVA code.
### Configuration file
-A file similar to the one shown below is all you need to get started.
+
+This is the main file used by the program, and one similar to that shown below is all you need to get started.
```toml
SHIM_URL = https://test.mycompany.com:8443/IDMProv/role/service
@@ -76,6 +77,8 @@ JAVA_KS_PASSWORD = changeit
### XML template file
+This is the XML file that is sent to the SOAP service once all search and replace tokens have been processed.
+
```xml
@@ -100,6 +103,7 @@ JAVA_KS_PASSWORD = changeit
```
### Java keystore
+
If the SOAP service uses https you have one of two choices for keystore:
- Use your own local keystore and specify it in the configuration file
@@ -108,6 +112,7 @@ If the SOAP service uses https you have one of two choices for keystore:
## Encrypt a password
+
To encrypt a password, run the linux_runner.sh bash script as shown below.
```zsh
@@ -120,6 +125,7 @@ Decoded / Decrypted : Password123
```
## Verification of the CSV input file
+
To verify the CSV input file, run the linux_verify.sh bash script as shown below.
```zsh
@@ -166,10 +172,11 @@ CSV file is valid : true
To run the program, just run the linux_runner.sh bash script shown at the beginning of this README.
### Getting Help
+
If you run the linux_runner.sh bash script with no command line parameters, you will receive a help screen.
```zsh
-keiarm@US09MAC769Q60KJ TEST % ./linux_runner.sh
+./linux_runner.sh
Usage: [options]
Options:
@@ -183,16 +190,28 @@ Usage: [options]
Location of the properties file
```
-### With Parameters
+### With command line parameters
+
+Please note that if the --key command line parameter and the --encrypt command line parameter are specified, the program will encrypt the passed value and exit.
+
+Initially, the program checks for the following potential issues before sending the SOAP XML to the SOAP service:
-The program checks the for the following potential issues before sending the SOAP document to the SOAP service:
-- The --key command line parameter is specified
-- The --props command line parameter is specified
+- The --key command line parameter is specified:
+
+- If specified, it must have a length of 16 characters
+- If NOT specified, you will be asked to enter it
+
+- The --props command line parameter is specified:
+
+- If specified, there is a check to make sure that the file exists
+
+- If configured, check that the encrypted password can be decrypted
- The CSV input file must exist
- The XML template file must exist
+A simple example is shown below.
```zsh
./linux_runner.sh --debug true --key 420CondoCondo420 --props props_USER_TO_ROLE.conf
@@ -234,4 +253,6 @@ Once the CSV file is processed, the data is sent to the SOAP service. The XML fi
-```
\ No newline at end of file
+```
+
+If you require any additional assistance, or you have any enhancement requests, please get in touch by visiting the Belkast Consulting website.