From b0f6b3d0d934cc5d384f061bd8fbd3007a6b2d58 Mon Sep 17 00:00:00 2001 From: hau Date: Wed, 11 Nov 2020 10:34:14 +0700 Subject: [PATCH] docs: add usage guide in README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a81dcfa..98d9375 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,21 @@ Tool to generate `CHANGELOG.md` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). -Install: +## Install ```sh 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 +```