Skip to content

Commit

Permalink
Update example in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed May 28, 2017
1 parent 96c7249 commit 1585a36
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,37 @@ npm install retext-equality

## Usage

```js
var retext = require('retext');
Say we have the following file, `example.txt`:

```text
He’s pretty set on beating your butt for sheriff.
```

And our script, `example.js`, looks like this:

```javascript
var vfile = require('to-vfile');
var report = require('vfile-reporter');
var unified = require('unified');
var english = require('retext-english');
var stringify = require('retext-stringify');
var equality = require('retext-equality');

var file = retext()
unified()
.use(english)
.use(equality)
.processSync('His network was set up with a master and slave.');

console.log(report(file));
.use(stringify)
.process(vfile.readSync('example.txt'), function (err, file) {
console.error(report(err || file));
});
```

Yields:
Now, running `node example` yields:

```text
<stdin>
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
example.txt
1:1-1:4 warning `His` may be insensitive, use `Their`, `Theirs`, `Them` instead her-him retext-equality
1:31-1:37 warning `master` / `slave` may be insensitive, use `primary` / `replica` instead master-slave retext-equality
⚠ 2 warnings
```
Expand Down

0 comments on commit 1585a36

Please sign in to comment.