updated documentation

Author: arturcic

docs/commands/add-assets.md

@@ -3,21 +3,30 @@
 Once a draft set of release notes has been created, it is possible to add additional assets to the release using the addasset command.
 
 ## **Required Parameters**
-  * `-u, -username`: The username to access GitHub with.
-  * `-p, -password`: The password to access GitHub with.
-  * `-o, -owner`: The owner of the repository.
-  * `-r, -repository`: The name of the repository.
-  * `-t, -tagName`: The name of the release (Typically this is the generated SemVer Version Number).
-  * `-a, -assets`: Path(s) to the file(s) to include in the release.  This is a comma separated list of files to include
+
+* `-u, --username`: The username to access GitHub with.
+* `-p, --password`: The password to access GitHub with.
+* `--token`: The access token to access GitHub with.
+* `-o, --owner`: The owner of the repository.
+* `-r, --repository`: The name of the repository.
+* `-t, --tagName`: The name of the release (Typically this is the generated SemVer Version Number).
+* `-a, --assets`: Path(s) to the file(s) to include in the release.  This is a comma separated list of files to include
 
 ## **Optional Parameters**
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+* `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+## **Notes**
+
+For Authentication use either username and password, or token parameter
 
 ## **Examples**
 
-```
+```bash
 gitreleasemanager.exe addasset -t 0.1.0 -u bob -p password -o repoOwner -r repo -a c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
 
-gitreleasemanager.exe create -tagName 0.1.0 -username bob -password password -owner repoOwner -repository repo -assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
+gitreleasemanager.exe create --tagName 0.1.0 --username bob --password password --owner repoOwner --repository repo --assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
+
+gitreleasemanager.exe create --tagName 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo --assets c:\buildartifacts\setup.exe,c:\buildartifacts\setup.nupkg
 ```

docs/commands/close.md

@@ -3,20 +3,29 @@
 Out of the box, publishing a release on GitHub does not close the milestone associated with the release.  This command, when executed, closes the specified milestone.
 
 ## **Required Parameters**
-  * `-u, -username`: The username to access GitHub with.
-  * `-p, -password`: The password to access GitHub with.
-  * `-o, -owner`: The owner of the repository.
-  * `-r, -repository`: The name of the repository.
-  * `-m, -milestone`: The milestone to use.
+
+* `-u, --username`: The username to access GitHub with.
+* `-p, --password`: The password to access GitHub with.
+* `--token`: The access token to access GitHub with.
+* `-o, --owner`: The owner of the repository.
+* `-r, --repository`: The name of the repository.
+* `-m, --milestone`: The milestone to use.
 
 ## **Optional Parameters**
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
 
-## **Examples** 
+* `-d, --targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, --logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+## **Notes**
+
+For Authentication use either username and password, or token parameter
 
-```
+## **Examples**
+
+```bash
 gitreleasemanager.exe close -m 0.1.0 -u bob -p password -o repoOwner -r repo
 
-gitreleasemanager.exe close -milestone 0.1.0 -username bob -password password -owner repoOwner -repository repo
+gitreleasemanager.exe close --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
+
+gitreleasemanager.exe close --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
 ```

docs/commands/create.md

@@ -5,35 +5,46 @@ This is the main command of GitReleaseManager and it is used to create a draft s
 There are two modes of operation when creating a Release.  GitReleaseManager can take as an input the name of the milestone to generate the release notes from.  Or, it can take as an input the name of a file which contains the release notes to include in the Release.
 
 ## **Required Parameters**
-  * `-u, -username`: The username to access GitHub with.
-  * `-p, -password`: The password to access GitHub with.
-  * `-o, -owner`: The owner of the repository.
-  * `-r, -repository`: The name of the repository.
+
+* `-u, --username`: The username to access GitHub with.
+* `-p, --password`: The password to access GitHub with.
+* `--token`: The access token to access GitHub with.
+* `-o, --owner`: The owner of the repository.
+* `-r, --repository`: The name of the repository.
 
 ## **Optional Parameters**
-  * `-m, -milestone`: The milestone to use.
-  * `-n, -name`: The name of the release (Typically this is the generated SemVer Version Number).
-  * `-i, -inputFilePath`: The path to the file to be used as the content of the release notes.
-  * `-e, -pre`: Creates the release as a pre-release.
-  * `-a, -assets`: Path(s) to the file(s) to include in the release.  This is a comma separated list of files to include
-  * `-c, -targetcommitish`: The commit to tag. Can be a branch or SHA. Defaults to repository's default branch.
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
 
-## **Examples** 
+* `-m, --milestone`: The milestone to use.
+* `-n, --name`: The name of the release (Typically this is the generated SemVer Version Number).
+* `-i, --inputFilePath`: The path to the file to be used as the content of the release notes.
+* `-e, --pre`: Creates the release as a pre-release.
+* `-a, --assets`: Path(s) to the file(s) to include in the release.  This is a comma separated list of files to include
+* `-c, --targetcommitish`: The commit to tag. Can be a branch or SHA. Defaults to repository's default branch.
+* `-d, --targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, --logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+## **Notes**
+
+For Authentication use either username and password, or token parameter
+
+## **Examples**
 
 Use GitReleaseManager to create a Release, generating the release notes based on Milestone:
 
-```
+```bash
 gitreleasemanager.exe create -m 0.1.0 -u bob -p password -o repoOwner -r repo
 
-gitreleasemanager.exe create -milestone 0.1.0 -username bob -password password -owner repoOwner -repository repo
+gitreleasemanager.exe create --milestone 0.1.0 --username bob --password password --owner repoOwner --repository repo
+
+gitreleasemanager.exe create --milestone 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
 ```
 
 Use GitReleaseManager to create a Release, taking the release notes as an input parameter:
 
-```
+```bash
 gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 -u bob -p password -o repoOwner -r repo
 
-gitreleasemanager.exe create -inputFilePath c:\temp\releasenotes.md -name 0.1.0 -username bob -password password -owner repoOwner -repository repo
+gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --username bob --password password --owner repoOwner --repository repo
+
+gitreleasemanager.exe create --inputFilePath c:\temp\releasenotes.md --name 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
 ```

docs/commands/export.md

@@ -5,23 +5,32 @@ This command will export all the release notes for a given repository on GitHub.
 There are two modes of operation when exporting Release Notes. GitReleaseManager can either export all Release Notes, or can export only a specific Release, using the tagName parameter.
 
 ## **Required Parameters**
-  * `-u, -username`: The username to access GitHub with.
-  * `-p, -password`: The password to access GitHub with.
-  * `-o, -owner`: The owner of the repository.
-  * `-r, -repository`: The name of the repository.
-  * `-f, -fileOutputPath`: Path to the file export releases.
+
+* `-u, --username`: The username to access GitHub with.
+* `-p, --password`: The password to access GitHub with.
+* `--token`: The access token to access GitHub with.
+* `-o, --owner`: The owner of the repository.
+* `-r, --repository`: The name of the repository.
+* `-f, --fileOutputPath`: Path to the file export releases.
 
 ## **Optional Parameters**
-  * `-t, -tagName`: The name of the release (Typically this is the generated SemVer Version Number).
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+* `-t, --tagName`: The name of the release (Typically this is the generated SemVer Version Number).
+* `-d, --targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, --logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+## **Notes**
+
+For Authentication use either username and password, or token parameter
 
 ## **Examples**
 
 Use GitReleaseManager to export all Release Notes:
 
-```
+```bash
 gitreleasemanager.exe export -u bob -p password -o repoOwner -r repo -f c:\temp\releases.md
 
-gitreleasemanager.exe export -username bob -password password -owner repoOwner -repository repo -fileOutputPath c:\temp\releases.md
+gitreleasemanager.exe export --username bob --password password --owner repoOwner --repository repo --fileOutputPath c:\temp\releases.md
+
+gitreleasemanager.exe export --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo --fileOutputPath c:\temp\releases.md
 ```

docs/commands/init.md

@@ -3,21 +3,26 @@
 The Init command is used to create GitReleaseManager.yaml which controls the configurable options of GitReleaseManager
 
 ## **Optional Parameters**
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
 
-## **Examples** 
+* `-d, --targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, --logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+## **Notes**
+
+For Authentication use either username and password, or token parameter
+
+## **Examples**
 
 Create a new GitReleaseManager.yaml file in the current working directory:
 
-```
+```bash
 gitreleasemanager.exe init
 ```
 
 Create a new GitReleaseManager.yaml file in a specific directory:
 
-```
+```bash
 gitreleasemanager.exe init -d c:\temp
 
-gitreleasemanager.exe init -targetDirectory c:\temp
+gitreleasemanager.exe init --targetDirectory c:\temp
 ```

docs/commands/publish.md

@@ -3,20 +3,29 @@
 While it would be possible to automatically publish a set of release notes in a single command, it is envisioned that some manual intervention is required to ensure that all release notes are valid, and any additional information is added to the release, prior to publishing.  As a result, a second command is required to actually publish a release.
 
 ## **Required Parameters**
-  * `-u, -username`: The username to access GitHub with.
-  * `-p, -password`: The password to access GitHub with.
-  * `-o, -owner`: The owner of the repository.
-  * `-r, -repository`: The name of the repository.
-  * `-t, -tagName`: The name of the release (Typically this is the generated SemVer Version Number).
+
+* `-u, --username`: The username to access GitHub with.
+* `-p, --password`: The password to access GitHub with.
+* `--token`: The access token to access GitHub with.
+* `-o, --owner`: The owner of the repository.
+* `-r, --repository`: The name of the repository.
+* `-t, --tagName`: The name of the release (Typically this is the generated SemVer Version Number).
 
 ## **Optional Parameters**
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
 
-## **Examples** 
+* `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+## **Notes**
+
+For Authentication use either username and password, or token parameter
 
-```
+## **Examples**
+
+```bash
 gitreleasemanager.exe publish -t 0.1.0 -u bob -p password -o repoOwner -r repo
 
-gitreleasemanager.exe publish -tagName 0.1.0 -username bob -password password -owner repoOwner -repository repo
+gitreleasemanager.exe publish --tagName 0.1.0 --username bob --password password --owner repoOwner --repository repo
+
+gitreleasemanager.exe publish --tagName 0.1.0 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
 ```

docs/commands/show-config.md

@@ -3,21 +3,22 @@
 The showconfig command is used to display the current configuration for GitReleaseManager when executed against a specific directory.
 
 ## **Optional Parameters**
-  * `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-  * `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
+
+* `-d, --targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
+* `-l, --logFilePath`: Path to where log file should be created. Defaults to logging to console.
 
 ## **Examples**
 
 Show the configuration for the current working directory:
 
-```
+```bash
 gitreleasemanager.exe showconfig
 ```
 
 Show the configuration for a specific directory:
 
-```
+```bash
 gitreleasemanager.exe showconfig -d c:\temp
 
-gitreleasemanager.exe showconfig -targetDirectory c:\temp
+gitreleasemanager.exe showconfig --targetDirectory c:\temp
 ```