Skip to content

Commit

Permalink
Rearrange usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cookpete committed Dec 31, 2015
1 parent 9351ad0 commit c6bfb0b
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ Command line tool for generating a changelog from git tags and commit history
[![Dependency Status](https://img.shields.io/david/CookPete/auto-changelog.svg)](https://david-dm.org/CookPete/auto-changelog)
[![devDependency Status](https://img.shields.io/david/dev/CookPete/auto-changelog.svg)](https://david-dm.org/CookPete/auto-changelog#info=devDependencies)


### Installation

```bash
npm install -g auto-changelog
```


### Usage

Just run in a local git repo. `git log` is run behind the scenes in order to parse commits.
Expand All @@ -28,12 +30,6 @@ Specify an output file with `-o` or `--output`.
auto-changelog --output HISTORY.md # Writes log to HISTORY.md
```

Use `-p` or `--package` to use the `version` from `package.json` as the latest release, which will parse _all commits between the previous release and now_ as part of that release. Essentially anything that would normally be parsed as `Unreleased` will now come under the `version` from `package.json`

```bash
auto-changelog --package
```

#### What you might do if you’re clever

- `npm install auto-changelog --save-dev`
Expand All @@ -51,6 +47,8 @@ auto-changelog --package
}
```

Using `--package` or `-p` uses the `version` from `package.json` as the latest release, so that _all commits between the previous release and now_ become part of that release. Essentially anything that would normally be parsed as `Unreleased` will now come under the `version` from `package.json`

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.


Expand Down

0 comments on commit c6bfb0b

Please sign in to comment.