Skip to content

Commit

Permalink
Refactor example in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed May 27, 2017
1 parent d91b548 commit 9d2afc9
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,35 @@ npm install retext-passive

## Usage

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

```text
He was withheld while we were being fed.
```

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 passive = require('retext-passive');

retext()
unified()
.use(english)
.use(passive)
.process('He was withheld while we were being fed.', function (err, file) {
.use(stringify)
.process(vfile.readSync('example.txt'), function (err, file) {
console.error(report(err || file));
});
```

Yields:
Now, running `node example` yields:

```txt
```text
example.txt
1:8-1:16 warning Don’t use the passive voice withheld retext-passive
1:37-1:40 warning Don’t use the passive voice fed retext-passive
Expand Down

0 comments on commit 9d2afc9

Please sign in to comment.