Update Readme
This commit is contained in:
parent
3ca37c75ae
commit
aad51e54e6
18
README.md
18
README.md
|
@ -1,4 +1,5 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
A changelog generator for Gitea
|
A changelog generator for Gitea
|
||||||
|
|
||||||
[![Build Status](https://drone.gitea.com/api/badges/gitea/changelog/status.svg)](https://drone.gitea.com/gitea/changelog)
|
[![Build Status](https://drone.gitea.com/api/badges/gitea/changelog/status.svg)](https://drone.gitea.com/gitea/changelog)
|
||||||
|
@ -19,18 +20,21 @@ See the [changelog.example.yml](config/changelog.example.yml) example file.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
#### Changelog Entries
|
### Changelog Entries
|
||||||
```
|
|
||||||
changelog -m=1.11.0 -c=/path/to/my_config_file generate
|
```sh
|
||||||
|
changelog generate -m=1.11.0 -c=/path/to/my_config_file
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Contributors List
|
### Contributors List
|
||||||
```
|
|
||||||
changelog -m=1.11.0 -c=/path/to/my_config_file contributors
|
```sh
|
||||||
|
changelog contributors -m=1.11.0 -c=/path/to/my_config_file
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
```
|
|
||||||
|
```sh
|
||||||
go build
|
go build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue