Skip to content

Commit

Permalink
docs: update to include new clap default help option
Browse files Browse the repository at this point in the history
  • Loading branch information
Coenraad Human committed Mar 27, 2023
1 parent 80357ed commit ec1c595
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Gibberish git history analyser, a terminal utility that uses conventional commit

Commands:
version Command to calculate the semantic version based on the conventional commits of the current branch.

Options:
-h, --help Prints help
```

__Version command options:__
Expand All @@ -26,6 +29,7 @@ Options:
-mi, --minor Bump current project version with a minor increment.
-p, --patch Bump current project version with a patch increment.
-pa, --path Specify the path of the git project.
-h, --help Prints help
```

### Docker
Expand All @@ -39,4 +43,4 @@ A docker image has been made for ease of use on pipelines such as Gitlab.

- [Semantic Version](https://semver.org/)
- [Conventional Commits](https://www.conventionalcommits.org/en/)
- [Conventional Commit Types]()
- [Conventional Commit Types](https://github.com/semantic-gitlog/semantic-gitlog/blob/master/docs/en-us/fundamentals/commit-types.md)
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<groupId>io.github.coenraadhuman</groupId>
<artifactId>gib</artifactId>
<version>0.6.4</version>
<version>0.6.5</version>
<name>gib</name>
<description>
Gibberish git history analyser, a terminal utility that uses conventional commits to analyse your git history.
Expand Down

0 comments on commit ec1c595

Please sign in to comment.