Skip to content

Commit

Permalink
README.md: Refactor
Browse files Browse the repository at this point in the history
Signed-off-by: Ce Gao <[email protected]>
  • Loading branch information
gaocegege committed Apr 28, 2017
1 parent 162d9df commit 7f863c6
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,25 @@

Maintainer is a CLI app which helps you to generate AUTHORS, CHANGELOG.md, CONTRIBUTING.md and so on based on the repository in GitHub. It makes your repository more contributor-friendly.

[![asciicast](https://asciinema.org/a/117832.png)](https://asciinema.org/a/117832)

## Installation

```bash
```text
$ go get github.com/gaocegege/maintainer
$ maintainer --help
maintainer is a CLI app to help you to generate AUTHORS, CONTRIBUTING.md, CHANGELOG.md and so on.
Usage:
maintainer [command]
Available Commands:
changelog Generate CHANGELOG.md for your repository.
contributing Generate CONTRIBUTING.md for your repository.
contributor Generate AUTHORS.md for your repository.
Flags:
--config string config file (default is $HOME/.maintainer.yaml)
Use "maintainer [command] --help" for more information about a command.
```

## The Docker Way
Expand All @@ -39,7 +51,9 @@ It is used in changelog subcommand, so there are three ways to config the token:
* Or Set environment variable `MAINTAINER_TOKEN`.
* Or Set the flag in changelog subcommand: `maintainer changelog --token <token>`. If you set it in command, it will override the configuration in config file and the environment variable.

## Features
## Features Preview

[![asciicast](https://asciinema.org/a/117832.png)](https://asciinema.org/a/117832)

### Generate CHANGELOG.md

Expand Down

0 comments on commit 7f863c6

Please sign in to comment.