Skip to content

Commit d92cf88

Browse files
committed
docs: update README
1 parent 1cbb1f2 commit d92cf88

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- [cc](#cc)
66
- [Changelog CLI](#changelog-cli)
7+
- [Installation](#installation)
78
- [Configuration](#configuration)
89
- [Usage](#usage)
910
- [Markdown](#markdown)
@@ -22,6 +23,14 @@ A small go library to parse [conventional commits](https://www.conventionalcommi
2223
## Changelog CLI
2324
The changelog cli creates and updates [CHANGELOG.md](./CHANGELOG.md) markdown files.
2425

26+
### Installation
27+
You can download a precompiled binary from the releases page or install it with go:
28+
29+
```console
30+
$ go install github.com/zbindenren/cc/cmd/changelog@latest
31+
```
32+
33+
2534
### Configuration
2635
You can create a default changelog configuration `.cc.yml` with `changelog -init-config`. This results in the following configuration:
2736

0 commit comments

Comments
 (0)