Skip to content

Commit 9d1b7fb

Browse files
authored
Update README.md
1 parent 39e73a0 commit 9d1b7fb

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# changerelease
22

3-
Sync your GitHub Release notes with your `CHANGELOG.md`.
3+
Automatically update your GitHub Releases from `CHANGELOG.md`.
44

55
This tool expects that you follow the [Keep a Changelog](https://keepachangelog.com/) format.
66

7+
To use it:
8+
9+
1. [Keep a Changelog](https://keepachangelog.com/)
10+
1. Git tag your versions
11+
1. Let the changerelease GitHub Action automatically keep your GitHub Releases updated
12+
713
## Use the GitHub Action
814

915
```yml

0 commit comments

Comments
 (0)