Merge pull request #65 from fod-dev/5.0.1-doc-update

5.0.1 doc update

Author: ryanpritchard

README.md

@@ -1,22 +1,16 @@
 # fod-uploader-java
-Java utility for uploading packages to FoD
+Java utility for uploading code to Fortify on Demand
 
 ## Usage
 
 ### Current
 
-*Note*: Command line arguments have been reworked since 3.1.0. When moving from an older version to the latest version, make sure to adjust your arguments to the current format.
+**Note**: Command line arguments have been reworked since 3.1.0. When upgrading from an older version to the latest version, make sure to adjust your arguments to the current format.
 
-Arguments are named and can be in any order: 
+The following table describes the FoDUploader arguments. Arguments are named and can be in any order: 
 
-```
-FodUpload.jar -ac <key> <secret> | -uc <username> <password> -rid <relID> | -bsi <token> -purl <purl> -aurl <aurl> -tc <tcode> -z <file> -ep <1|SingleScanOnly|2|SubscriptionOnly|3|SingleScanFirstThenSubscription|4|SubscriptionFirstThenSingleScan> -rp <0|RemediationScanIfAvailable|1|RemediationScanOnly|2|NonRemediationScanOnly> -pp <0|DoNotStartScan|1|CancelScanInProgress> [-purchase] [-b] [-I <minutes>] [-p <1|Standard|2|Express>] [-a <1|Manual|2|Automated>] [-P <proxyUrl> <username> <password> <ntDomain> <ntWorkstation>] [-itp] [-os] [-n] [-h] [-v]
-```
-
-Each argument has a short and long name:
-
-Short Name | Long Name                     | Required? | Description                                                      
----------- | ----------------------        |:---------:| --------------------------------------------------------
+Short Name | Long Name                     | Required?         | Description                                                      
+---------- | ----------------------        |---------          | --------------------------------------------------------
  -ac       | -apiCredentials               | Yes<sup>1</sup>   | API credentials ("key:" does not need to be appended to `<key>`)                                                  
  -uc       | -userCredentials              | Yes<sup>1</sup>   | User credentials (wrap each in quotations to avoid escaping characters in the CLI) 
  -bsi      | -bsiToken                     | Yes<sup>2</sup>   | Build server token
@@ -27,24 +21,31 @@ Short Name | Long Name                     | Required? | Description
  -z        | -zipLocation                  | Yes               | Location of scan
  -ep       | -entitlementPreferenceType    | Yes               | Whether to use a single scan or subscription assessment: 1/SingleScanOnly, 2/SubscriptionOnly, 3/SingleScanFirstThenSubscription, 4/SubscriptionFirstThenSingleScan
  -rp       | -remediationScanPreferenceType| No                | Whether to run a remediation scan: 0/RemediationScanIfAvailable, 1/RemediationScanOnly, 2/NonRemediationScanOnly (default)
- -pp       | -inProgressScanActionType     | No                | Whether to cancel an in-progress scan and start a new scan or not start a scan: 0/DoNotStartScan (default), 1/CancelScanInProgress                    
+ -pp       | -inProgressScanActionType     | No                | If in-progress scan exists, whether to not start a scan, cancel in-progress scan and start a scan, or queue a scan: 0/DoNotStartScan (default), 1/CancelScanInProgress, 2/Queue                     
+ -n        | -notes                        | No                | The notes about the scan 
+ -purchase | -purchaseEntitlement          | No		           | Whether to purchase an entitlement (if available)
  -I        | -pollingInterval              | No                | Interval between checking scan status in minutes                 
  -P        | -proxy                        | No                | Credentials for accessing the proxy                   
  -h        | -help                         | No                | Print help dialog                                                
  -v        | -version                      | No                | Print jar version   
- -purchase | -purchaseEntitlement          | No		              | Whether to purchase an entitlement (if available)
- -n        | -notes                        | No                | The notes about the scan
 
-<sup>1</sup>One of either apiCredentials or userCredentials is required.  
+
+
+<sup>1</sup>Use either apiCredentials or userCredentials.  
 <sup>2</sup>Use either release ID or BSI token. If both are provided, then the scan settings that are retrieved from the release ID will be used.  
 <sup>3</sup>Required if BSI token is not provided.
 
+Usage:
+```
+FodUpload.jar {-ac <key> <secret> | -uc <username> <password>} {-rid <relID> | -bsi <token>} -purl <purl> -aurl <aurl> -tc <tcode> -z <zip_file_path> -ep {1|SingleScanOnly|2|SubscriptionOnly|3|SingleScanFirstThenSubscription|4|SubscriptionFirstThenSingleScan} [-rp {0|RemediationScanIfAvailable|1|RemediationScanOnly|2|NonRemediationScanOnly}] [-pp {0|DoNotStartScan|1|CancelScanInProgress|2|Queue}] [-purchase] [-n] [-I <minutes>] [-P <proxyUrl> <username> <password> <ntDomain> <ntWorkstation>] [-h] [-v]
+```
+
 ### Previous
 
-If you are using 3.1.0, the arguments are:
+The following table describes the FoDUploader arguments for 3.1.0:
 
 Short Name | Long Name              | Required? | Description                                                      
----------- | ---------------------- |:---------:| --------------------------------------------------------
+---------- | ---------------------- |---------  | --------------------------------------------------------
  -bsi      | -bsiToken              | Yes       | Build server token
  -z        | -zipLocation           | Yes       | Location of scan 
  -ep       | -entitlementPreference | Yes       | Whether to use a single scan or subscription assessment (if available) (1/Single, 2/Subscription)
@@ -63,9 +64,16 @@ Short Name | Long Name              | Required? | Description
  -purchase | -purchaseEntitlement   | No		| Whether to purchase an entitlement (if available)
  -n        | -notes                 | No        | The notes about the scan.
 
+*Use either apiCredentials or userCredentials.
+
+Usage:
+```
+FodUpload.jar -bsi <token> -z <file> {-ac <key> <secret> | -uc <username> <password>} -ep {1|SingleScan|2|Subscription} [-p {1|Standard|2|Express}] [-a {1|Manual|2|Automated}] [-itp] [-os] [-b] [-r] [-purchase] [-n] [-I <minutes>] [-P <proxyUrl> <username> <password> <ntDomain> <ntWorkstation>] [-h] [-v] 
+```
+ 
 ## Developer Setup
 
-The FoD-Uploader is configured to build a fat jar with the Gradle Shadow plugin as the default gradle task.
+FoDUploader is configured to build a fat jar with the Gradle Shadow plugin as the default gradle task.
 
 To compile, simply use the gradlew or gradlew.bat depending on your operating system.