Updated usage files.

Author: jason-c-daniels

README.md

@@ -8,7 +8,7 @@ I wanted a highly portable tool with no dependency on tools outside of git. In s
 
 ### Why bash?
 
-It's a shell that I use on Windows and of course linux. It's also supported on Mac OS. Many CI/CD tools are built on `docker`, and therefore, by default, Linux.
+It's a shell that I use on Windows and of course Linux. It's also supported on Mac OS. Many CI/CD tools are built on `docker`, and therefore, by default, Linux.
 
 ### Why not just use GitVersion?
 
@@ -32,7 +32,7 @@ For more details on the individual commands type `git-ver help [command]`
 
 `get-rev` : Counts the number of commits from the last tag and returns that as a revision number. (placed in info as _info_**#**)
 
-`get-semver` : Retrieves a full semantic version, optionally with
+`get-semver` : Retrieves a full semantic version, optionally with metadata (+r1; +dYYYYMMDD-hhmmss)
 
 `get-suffix` : gets the suffix for a pre-release semantic version. (e.g. -alpha1)
 

src/git-ver-help

@@ -16,7 +16,7 @@ get-prefix : Returns the version with a prefix, prefix defaults to 'v'
 
 get-rev : Counts the number of commits from the last tag and returns that as a revision number. (placed in info as .rev#)
 
-get-semver : Retrieves a full semantic version, optionally with 
+get-semver : Retrieves a full semantic version, optionally with metadata (+r1; +dYYYYMMDD-hhmmss)
 
 get-suffix : gets the suffix for a pre-release semantic version. (e.g. -alpha.1)
 

src/git-ver-help-get-semver

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+echo "
+usage: git-ver get-semver [-r] [-d]
+get-semver : Retrieves a full semantic version, optionally with metadata (+r1; +dYYYYMMDD-hhmmss)
+
+To establish a suffix, the following steps are taken.
+ 1. The candidate revision number is retrieved.
+ 2. If present, the suffix from the latest tag is used.
+ 3. If no tag suffix is extract, the branch name is used instead.
+ 4. The master branch gets no suffix. Only actual releases happen from it.
+ 5. A branch with a name starting with release gets the suffix of -rc
+ 6. A branch with a name starting with develop gets the suffix of -beta
+ 7. A branch with a name starting with feature gets the suffix of -alpha
+ 8. All other branches get a suffix of -pre
+
+There are two additional optional metadata parameters.
+ -r | --rev : This includes the results of git-ver get-rev as metadata after the main part of the suffix. For example: -rc+5
+ -d | --date : This includes the build date and time in the following format: YYMMDD-HHmmss. For example: -alpha+20180606.211206
+
+ COMING SOON: -r and -d can be used with each other. When this is done -r is appended first, then -d. For example: -rc+5+20180806.011033
+"

src/git-ver-help-get-suffix

@@ -14,11 +14,11 @@ To establish a suffix, the following steps are taken.
  7. A branch with a name starting with feature gets the suffix of -alpha
  8. All other branches get a suffix of -pre
 
-There are two additional optional meta data parameters.
+There are two additional optional metadata parameters.
  -r | --rev : This includes the results of git-ver get-rev as metadata after the main part of the suffix. For example: -rc+5
- -d | --date : This includes the build date and time in the following format: YYMMDD.HHmmss. For example: -alpha+20180606.211206
+ -d | --date : This includes the build date and time in the following format: YYMMDD-HHmmss. For example: -alpha+20180606.211206
 
- -r and -d can be used with each other. When this is done -r is appended first, then -d. For example: -rc+5+20180806.011033
+ COMING SOON: -r and -d can be used with each other. When this is done -r is appended first, then -d. For example: -rc+5+20180806.011033
 
- NOTE: -r and -d are passed on tho this command when calling git-ver get-semver
+ NOTE: -r and -d are passed on to this command when calling git-ver get-semver
 "