Skip to content

Commit

Permalink
Refactor prose
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed May 30, 2019
1 parent 3f8e58c commit 5b5240a
Showing 1 changed file with 31 additions and 11 deletions.
42 changes: 31 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,18 @@
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

Count [vfile][] messages per category (fatal, warn, info, nonfatal and total).

## Installation
## Install

[npm][]:

```bash
```sh
npm install vfile-statistics
```

Expand Down Expand Up @@ -45,8 +48,8 @@ Yields:

### `statistics(file)`

Pass a [vfile][], list of vfiles, or a list of messages
(`file.messages`), get counts per category.
Pass a [vfile][], list of vfiles, or a list of messages (`file.messages`), get
counts per category.

###### Returns

Expand All @@ -60,10 +63,13 @@ Pass a [vfile][], list of vfiles, or a list of messages

## Contribute

See [`contributing.md` in `vfile/vfile`][contributing] for ways to get started.
See [`contributing.md`][contributing] in [`vfile/.github`][health] for ways to
get started.
See [`support.md`][support] for ways to get help.

This organisation has a [Code of Conduct][coc]. By interacting with this
repository, organisation, or community you agree to abide by its terms.
This project has a [Code of Conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

## License

Expand All @@ -83,18 +89,32 @@ repository, organisation, or community you agree to abide by its terms.

[downloads]: https://www.npmjs.com/package/vfile-statistics

[size-badge]: https://img.shields.io/bundlephobia/minzip/vfile-statistics.svg

[size]: https://bundlephobia.com/result?p=vfile-statistics

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg

[chat]: https://spectrum.chat/unified/vfile

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

[contributing]: https://github.com/vfile/.github/blob/master/contributing.md

[support]: https://github.com/vfile/.github/blob/master/support.md

[health]: https://github.com/vfile/.github

[coc]: https://github.com/vfile/.github/blob/master/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[vfile]: https://github.com/vfile/vfile

[contributing]: https://github.com/vfile/vfile/blob/master/contributing.md

[coc]: https://github.com/vfile/vfile/blob/master/code-of-conduct.md

0 comments on commit 5b5240a

Please sign in to comment.