-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md commands and header
- Loading branch information
Showing
1 changed file
with
22 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,42 @@ | ||
## kac | ||
<br> | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<svg width="112px" height="39px" viewBox="0 0 112 39" version="1.1" xmlns="http://www.w3.org/2000/svg"> | ||
<title>kac</title> | ||
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" font-family="Monoton-Regular, Monoton" font-size="50" font-weight="normal" letter-spacing="-1.57142833"> | ||
<text id="kac" fill="#000000"> | ||
<tspan x="-1.90799422" y="37">kac</tspan> | ||
</text> | ||
</g> | ||
</svg> | ||
<hr> | ||
|
||
A command line tool for CHANGELOG files that follow the [Keep A Changelog][1] standard. | ||
|
||
![Tests](https://github.com/atwalsh/kac/workflows/Tests/badge.svg) | ||
|
||
### Usage | ||
Run `kac` in the same directory as your Changelog. By default, `kac` looks for a file called `CHANGELOG.md` | ||
|
||
Run `kac` in the same directory as your Changelog. By default, `kac` looks for a file called `CHANGELOG.md` | ||
(case-insensitive). | ||
|
||
```bash | ||
``` | ||
Usage: kac [OPTIONS] COMMAND [ARGS]... | ||
A CLI tool for CHANGELOG files that follow the Keep-a-Changelog standard. | ||
Options: | ||
--help Show this message and exit. | ||
Commands: | ||
bump Bump a Changelog. | ||
copy Copy a version's release text. | ||
new Create an empty CHANGELOG.md file. | ||
bump Bump the latest version of a CHANGELOG file. | ||
copy Copy the latest release's changelog text. | ||
init Create an empty CHANGELOG file. | ||
``` | ||
|
||
## Limitations | ||
|
||
- Must be run in the same directory as your CHANGELOG file | ||
- Assumes you have changes in the "Unreleased" section | ||
- Only works for semver | ||
- Only supports versions in the `MAJOR.MINOR.PATCH` format. A beta version ending in `-beta`, for example, | ||
will fail. | ||
## To-Do | ||
- [ ] Add default text for versions with no notable changes | ||
- [ ] Undo bump | ||
- [ ] Support labels for pre-release and build metadata | ||
|
||
[1]: https://keepachangelog.com/en/1.0.0/ |