Skip to content

Commit

Permalink
Refactor prose
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jun 4, 2019
1 parent f615fcb commit e2e7bde
Showing 1 changed file with 41 additions and 16 deletions.
57 changes: 41 additions & 16 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# retext-simplify [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
# retext-simplify

Check phrases for simpler alternatives with [**retext**][retext].
[![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]

## Installation
[**retext**][retext] plugin to check phrases for simpler alternatives.

## Install

[npm][]:

```bash
```sh
npm install retext-simplify
```

## Usage
## Use

Say we have the following file, `example.txt`:

```text
```txt
You can utilize a shorter word.
Be advised, don’t do this.
That’s the appropriate thing to do.
```

And our script, `example.js`, looks as follows:
…and our script, `example.js`, looks as follows:

```javascript
```js
var vfile = require('to-vfile')
var report = require('vfile-reporter')
var retext = require('retext')
Expand All @@ -37,7 +45,7 @@ retext()

Yields:

```text
```txt
example.txt
1:9-1:16 warning Replace “utilize” with “use” utilize retext-simplify
2:1-2:11 warning Remove “Be advised” be-advised retext-simplify
Expand Down Expand Up @@ -69,10 +77,13 @@ Check phrases for simpler alternatives.

## Contribute

See [`contribute.md` in `retextjs/retext`][contribute] for ways to get started.
See [`contributing.md`][contributing] in [`retextjs/.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 @@ -92,18 +103,32 @@ repository, organisation, or community you agree to abide by its terms.

[downloads]: https://www.npmjs.com/package/retext-simplify

[size-badge]: https://img.shields.io/bundlephobia/minzip/retext-simplify.svg

[size]: https://bundlephobia.com/result?p=retext-simplify

[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/retext

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

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

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

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

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

[license]: license

[author]: https://wooorm.com

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

[contribute]: https://github.com/retextjs/retext/blob/master/contributing.md

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

0 comments on commit e2e7bde

Please sign in to comment.