diff --git a/README.md b/README.md index 8016e1722..250f57408 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Coverage Status](https://coveralls.io/repos/conventional-changelog/standard-version/badge.svg?branch=)](https://coveralls.io/r/conventional-changelog/standard-version?branch=master) [![Standard Version](https://img.shields.io/badge/standard-version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version) -> stop using `npm version`, use `standard-version` it makes your life way easier. +> stop using `npm version`, use `standard-version` it rocks! Automatic release and CHANGELOG management, using GitHub's new squash button and the workflow outlined in [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md). @@ -22,7 +22,7 @@ _how it works:_ `standard-version` does the following: 1. bumps the version in package.json (based on your commit history). -2. runs `conventional-changelog` and updates _CHANGELOG.md._ +2. uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) to update _CHANGELOG.md._ 3. commits _package.json_ and _CHANGELOG.md_. 4. tags a new release. @@ -36,13 +36,11 @@ When you're generating your changelog for the first time, simply do: `npm i standard-version -g` -## Automating - -Do this: +_Or, add it as a development dependency like so:_ `npm i standard-version --save-dev` -Add this to your _package.json_ +_And add this to your _package.json:_ ```json { @@ -81,6 +79,11 @@ You decide, e.g., docs, chore, etc. git commit -a -m "docs: fixed up the docs a bit" ``` +_but wait, there's more!_ + +Github usernames (`@bcoe`) and issue references (#133) will be swapped out for the +appropriate URLs in your CHANGELOG. + ## Badges! Tell your users that you adhere to the `standard-version` commit guidelines: diff --git a/package.json b/package.json index 9cd25954a..f70172992 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "dependencies": { "chalk": "^1.1.3", "conventional-changelog": "^1.1.0", - "conventional-changelog-standard": "^1.1.0", + "conventional-changelog-standard": "^1.2.1", "conventional-recommended-bump": "^0.2.0", "figures": "^1.5.0", "fs-access": "^1.0.0", @@ -45,4 +45,4 @@ "shelljs": "^0.6.0", "standard": "^6.0.8" } -} \ No newline at end of file +}