Skip to content

Commit

Permalink
Update README.md commands and header
Browse files Browse the repository at this point in the history
  • Loading branch information
atwalsh committed Jan 16, 2021
1 parent 366be66 commit dc87904
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
## kac
![kac](https://atw.me/img/kac.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/

0 comments on commit dc87904

Please sign in to comment.