Skip to content

Commit

Permalink
Refactor readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Feb 3, 2016
1 parent d3c0be4 commit d54f3bd
Showing 1 changed file with 33 additions and 10 deletions.
43 changes: 33 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# retext-equality [![Build Status](https://img.shields.io/travis/wooorm/retext-equality.svg)](https://travis-ci.org/wooorm/retext-equality) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/retext-equality.svg)](https://codecov.io/github/wooorm/retext-equality)
# retext-equality [![Build Status][travis-badge]][travis] [![Coverage Status][coverage-badge]][coverage]

Warn about possible insensitive, inconsiderate language with
[**retext**](https://github.com/wooorm/retext).
[**retext**][retext].

## Installation

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

```bash
npm install retext-equality
```

**retext-equality** is also available for
[duo](http://duojs.org/#getting-started), and as an AMD, CommonJS, and
globals module, [uncompressed and compressed](https://github.com/wooorm/retext-equality/releases).
**retext-equality** is also available for [duo][], and as an AMD, CommonJS,
and globals module, [uncompressed and compressed][releases].

## Usage

Expand All @@ -35,8 +34,8 @@ Yields:

```text
<stdin>
1:1-1:4 warning `His` may be insensitive, use `Their`, `Theirs`, `Them` instead
1:31-1:37 warning `master` / `slave` may be insensitive, use `primary` / `replica` instead
1:1-1:4 warning `His` may be insensitive, use `Their`, `Theirs`, `Them` instead her-him
1:31-1:37 warning `master` / `slave` may be insensitive, use `primary` / `replica` instead master-slave
⚠ 2 warnings
```
Expand All @@ -46,7 +45,7 @@ Yields:
### `retext.use(equality[, options])`

Adds warnings for possible insensitive, inconsiderate language to the
processed [virtual file](https://github.com/wooorm/vfile)s.
processed [virtual file][vfile]s.

**Parameters**

Expand All @@ -64,4 +63,28 @@ processed [virtual file](https://github.com/wooorm/vfile)s.

## License

[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
[MIT][license] © [Titus Wormer][home]

<!-- Definitions -->

[travis-badge]: https://img.shields.io/travis/wooorm/retext-equality.svg

[travis]: https://travis-ci.org/wooorm/retext-equality

[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/retext-equality.svg

[coverage]: https://codecov.io/github/wooorm/retext-equality

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

[duo]: http://duojs.org/#getting-started

[releases]: https://github.com/wooorm/retext-equality/releases

[license]: LICENSE

[home]: http://wooorm.com

[retext]: https://github.com/wooorm/retext

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

0 comments on commit d54f3bd

Please sign in to comment.