Update README markdown.

This commit is contained in:
2021-05-09 19:15:05 +01:00
parent 1b2292f6cb
commit c57c2e008a
+5 -5
View File
@@ -28,7 +28,7 @@ bash$ ./semver-gen generate -l
SEMVER 5.1.1 SEMVER 5.1.1
``` ```
** Local repository flag `-l` will always take precedence over remote repository URL ** **Local repository flag `-l` will always take precedence over remote repository URL**
```yaml ```yaml
Usage: Usage:
@@ -106,10 +106,10 @@ wording:
- the # For testing purposes - the # For testing purposes
``` ```
* version: is not respected at the moment, introduced for potential backwards compatibility in future * `version`: is not respected at the moment, introduced for potential backwards compatibility in future
* force: sets the "starting" version, you don't need to specify this section as the default is always `0` * `force`: sets the "starting" version, you don't need to specify this section as the default is always `0`
* force.commit allows you to set commit hash from which the calculations should start * `force.commit`: allows you to set commit hash from which the calculations should start
* wording: words the program should look for in the git commits to increment (patch|minor|major) * `wording`: words the program should look for in the git commits to increment (patch|minor|major)
### Good to know ### Good to know