Skip to content

Commit

Permalink
Refactor docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jul 17, 2017
1 parent 8a8bc41 commit c085cff
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Count [vfile][] messages per category (fatal, warn, info, nonfatal and total).

## Installation

[npm][npm-install]:
[npm][]:

```bash
npm install vfile-statistics
Expand Down Expand Up @@ -43,6 +43,16 @@ Yields:
Pass a [vfile][], list of vfiles, or a list of messages
(`file.messages`), get counts per category.

###### Returns

`Object`:

* `fatal`: fatal errors (`fatal: true`)
* `warn`: warning messages (`fatal: false`)
* `info`: informational messages (`fatal: null` or `fatal: undefined`)
* `nonfatal`: warning or info messages
* `total`: all messages

## License

[MIT][license] © [Titus Wormer][author]
Expand All @@ -57,7 +67,7 @@ Pass a [vfile][], list of vfiles, or a list of messages

[codecov]: https://codecov.io/github/vfile/vfile-statistics

[npm-install]: https://docs.npmjs.com/cli/install
[npm]: https://docs.npmjs.com/cli/install

[license]: LICENSE

Expand Down

0 comments on commit c085cff

Please sign in to comment.