Skip to content

Commit

Permalink
Fix example in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jan 14, 2016
1 parent 755f7f3 commit a783a82
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ var report = require('vfile-reporter');

retext()
.use(simplify)
.process('You can utilize a shorter word', function (err, file) {
.process([
'You can utilize a shorter word.',
'Be advised, don’t do this.',
'That’s the appropriate thing to do.'
].join('\n'), function (err, file) {
console.log(report(file));
});
```
Expand All @@ -31,9 +35,11 @@ Yields:

```txt
<stdin>
3:1-5:57 warning Very hard to read sentence
1:9-1:16 warning Replace “utilize” with “use” utilize
2:1-2:11 warning Remove “Be advised” be advised
3:12-3:23 warning Replace “appropriate” with “proper”, “right”, or remove it appropriate
1 warning
3 warnings
```

## API
Expand Down

0 comments on commit a783a82

Please sign in to comment.