yoshie
/
changeloguru
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: add usage guide in README

main
hau 2020-11-11 10:34:14 +07:00
parent 71630969cd
commit b0f6b3d0d9
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -4,8 +4,21 @@
Tool to generate `CHANGELOG.md` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Tool to generate `CHANGELOG.md` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
Install: ## Install
```sh ```sh
GO111module=on go get github.com/haunt98/changeloguru GO111module=on go get github.com/haunt98/changeloguru
``` ```
## Usage
```sh
# Help
changeloguru --help
# Generate changelog v2.0.0 from HEAD to tag v1.0.0 (include commit in tag v1.0.0)
changeloguru --include-to v1.0.0 --version v2.0.0
# Generate changelog v2.0.0 from HEAD to tag v1.0.0 (exclude commit in tag v1.0.0)
changeloguru --exclude-to v1.0.0 --version v2.0.0
```