diff --git a/.markdownlintrc b/.markdownlintrc index 52fc0314..390db8cf 100644 --- a/.markdownlintrc +++ b/.markdownlintrc @@ -3,5 +3,7 @@ "line-length": false, "first-header-h1": false, "first-line-h1": false, - "no-duplicate-header": false + "no-duplicate-header": false, + "heading-increment": false, + "no-trailing-punctuation": false } diff --git a/README.md b/README.md index 5b87f742..b743a72a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -auto-changelog -============== +# auto-changelog Command line tool for generating a changelog from git tags and commit history @@ -8,14 +7,12 @@ Command line tool for generating a changelog from git tags and commit history [![Greenkeeper](https://img.shields.io/badge/greenkeeper-enabled-brightgreen.svg)](https://greenkeeper.io) [![Test Coverage](https://img.shields.io/codecov/c/github/cookpete/auto-changelog.svg)](https://codecov.io/gh/CookPete/auto-changelog) - ### Installation ```bash npm install -g auto-changelog ``` - ### Usage Simply run `auto-changelog` in the root folder of a git repository. `git log` is run behind the scenes in order to parse the commit history. @@ -265,14 +262,16 @@ If you are upgrading from `0.x`, the same options are still supported out of the If anything isn’t working correctly, [open an issue](https://github.com/CookPete/auto-changelog/issues). - ### FAQ #### What’s a changelog? + See [keepachangelog.com](http://keepachangelog.com). #### What does this do? + The command parses your git commit history and generates a changelog based on tagged versions, merged pull requests and closed issues. See a simple example in [this very repo](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](#what-you-might-do-if-youre-clever). diff --git a/package.json b/package.json index 37cd7ced..0a552477 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ }, "scripts": { "lint": "standard --verbose | snazzy", - "lint-markdown": "markdownlint test/data/*.md", + "lint-markdown": "markdownlint README.md test/data/*.md", "test": "cross-env NODE_ENV=test nyc mocha test", "coverage": "nyc report --reporter=json && codecov -f coverage/coverage-final.json", "clean": "rm -rf lib coverage",