Skip to content

Commit

Permalink
Add README.md to lint checks
Browse files Browse the repository at this point in the history
Because why not?
  • Loading branch information
cookpete committed Jun 28, 2018
1 parent 9f08899 commit 5aab29f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .markdownlintrc
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
auto-changelog
==============
# auto-changelog

Command line tool for generating a changelog from git tags and commit history

Expand All @@ -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.
Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 5aab29f

Please sign in to comment.