Add documentation for format input

PaulHatch · Dec 10, 2019 · 118c3fd · 118c3fd
1 parent caa92bb
commit 118c3fd
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -30,4 +30,6 @@ message alters the type of change the next version will represent.
     major_pattern: "(MAJOR)"
     # Same as above except indicating a minor change
     minor_pattern: "(MINOR)"
+    # A string to determine the format of the version output
+    format: "${major}.${minor}.${patch}-prerelease.${increment}"
 ```