From c6bfb0be0b429ce7f9697eb1097ec3e2288aff74 Mon Sep 17 00:00:00 2001 From: Pete Cook Date: Thu, 31 Dec 2015 15:34:46 +0000 Subject: [PATCH] Rearrange usage docs --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e9934522..2b4a3d9d 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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` @@ -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.