gitea-mirror
/
changelog
mirror of https://gitea.com/gitea/changelog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Readme

This commit is contained in:
6543 2022-09-15 19:14:09 +02:00
parent 3ca37c75ae
commit aad51e54e6
No known key found for this signature in database
GPG Key ID: B8BE6D610E61C862
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,4 +1,5 @@
# Changelog
A changelog generator for Gitea
[![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
#### Changelog Entries
```
changelog -m=1.11.0 -c=/path/to/my_config_file generate
### Changelog Entries
```sh
changelog generate -m=1.11.0 -c=/path/to/my_config_file
```
#### Contributors List
```
changelog -m=1.11.0 -c=/path/to/my_config_file contributors
### Contributors List
```sh
changelog contributors -m=1.11.0 -c=/path/to/my_config_file
```
## Building
```
```sh
go build
```