Skip to content

Commit

Permalink
Add changelog help output under Usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
rcmachado committed Aug 5, 2018
1 parent 9444763 commit 6fd6522
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,37 @@ $ make build

## Usage

```!bash
changelog manipulate and validate markdown changelog files following the keepachangelog.com specification.
Usage:
changelog [command]
Available Commands:
fmt Reformat the change log file
help Help about any command
release Change Unreleased to [version]
show Show changelog for [version]
Flags:
-f, --filename string Changelog file or '-' for stdin (default "CHANGELOG.md")
-h, --help help for changelog
-o, --output string Output file or '-' for stdout (default "-")
Use "changelog [command] --help" for more information about a command.
```

### fmt

Normalize file format (see [Formatting](#formatting) for the specific
transformation applied):

```bash
$ changelog fmt
```

### show

Show what will be in the next release:

```bash
Expand All @@ -50,6 +74,8 @@ Show the change log for a specific version:
$ changelog show 1.2.3
```

### release

Create a new release:

```bash
Expand Down

0 comments on commit 6fd6522

Please sign in to comment.