Skip to content

Commit

Permalink
Add FAQ to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cookpete committed Dec 31, 2015
1 parent c6a6b13 commit 9351ad0
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,15 @@ auto-changelog --package
```

Now every time you run [`npm version`](https://docs.npmjs.com/cli/version), the changelog will automatically update and be part of the version commit.


### FAQ

#### What’s a changelog?
See [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog#whats-a-change-log).

#### What does this do?
The command parses a git commit history and generates a changelog based on tagged versions, merged pull requests and closed issues. The default output attempts to follow the schema outlined by [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog). See a simple example in [this very repo](https://github.com/CookPete/auto-changelog/blob/master/CHANGELOG.md).

#### Why do I need it?
Because keeping a changelog can be tedious and difficult to get right. If you don’t have the patience for a hand-crafted, bespoke changelog then this makes keeping one rather easy. It also can be automated if you’re feeling extra lazy (see [What you might do if you’re clever](#what-you-might-do-if-youre-clever) above).

0 comments on commit 9351ad0

Please sign in to comment.