(doc) Added additional information to parameters

Author: gep13

docs/commands/add-assets.md

@@ -4,9 +4,9 @@ Once a draft set of release notes has been created, it is possible to add additi
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.
-* `-p, --password`: The password to access GitHub with.
-* `--token`: The access token to access GitHub with.
+* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
 * `-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).
@@ -29,4 +29,4 @@ gitreleasemanager.exe addasset -t 0.1.0 -u bob -p password -o repoOwner -r repo
 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

@@ -4,9 +4,9 @@ Out of the box, publishing a release on GitHub does not close the milestone asso
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.
-* `-p, --password`: The password to access GitHub with.
-* `--token`: The access token to access GitHub with.
+* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
 * `-o, --owner`: The owner of the repository.
 * `-r, --repository`: The name of the repository.
 * `-m, --milestone`: The milestone to use.
@@ -28,4 +28,4 @@ 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 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
-```
+```

docs/commands/create.md

@@ -6,9 +6,9 @@ There are two modes of operation when creating a Release.  GitReleaseManager can
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.
-* `-p, --password`: The password to access GitHub with.
-* `--token`: The access token to access GitHub with.
+* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
 * `-o, --owner`: The owner of the repository.
 * `-r, --repository`: The name of the repository.
 
@@ -47,4 +47,4 @@ gitreleasemanager.exe create -i c:\temp\releasenotes.md -n 0.1.0 -u bob -p passw
 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

@@ -6,9 +6,9 @@ There are two modes of operation when exporting Release Notes. GitReleaseManager
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.
-* `-p, --password`: The password to access GitHub with.
-* `--token`: The access token to access GitHub with.
+* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
 * `-o, --owner`: The owner of the repository.
 * `-r, --repository`: The name of the repository.
 * `-f, --fileOutputPath`: Path to the file export releases.
@@ -33,4 +33,4 @@ gitreleasemanager.exe export -u bob -p password -o repoOwner -r repo -f c:\temp\
 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/publish.md

@@ -4,9 +4,9 @@ While it would be possible to automatically publish a set of release notes in a
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.
-* `-p, --password`: The password to access GitHub with.
-* `--token`: The access token to access GitHub with.
+* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
 * `-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).
@@ -28,4 +28,4 @@ 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 --token fsdfsf67657sdf5s7d5f --owner repoOwner --repository repo
-```
+```