Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Closes GH-94.
Closes GH-95.
  • Loading branch information
ms-217 authored and wooorm committed Jun 19, 2016
1 parent ce8f7c9 commit e94f747
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Have a feature request? Found a bug? Awesome, and in the latter case, sorry!

Is this your first time contributing to open-source? Cool! Don’t be alarmed,
don’t hold back.
and don’t hold back.

Issues can be opened on [GitHub Issues](https://github.com/wooorm/alex/issues).

Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

Whether your own or someone else’s writing, **alex** helps you find gender
favouring, polarising, race related, religion inconsiderate, or other
**unequal** phrasing.
**unequal** phrasing in text.

For example, when `We’ve confirmed his identity` is given to **alex**,
it will warn you and suggest using `their` instead of `his`.
Expand All @@ -23,7 +23,7 @@ Give **alex** a spin on the [Online demo »][demo].

## Why

* [x] To get better at considerate writing;
* [x] Helps to get better at considerate writing;
* [x] Catches many possible offenses;
* [x] Suggests helpful alternatives;
* [x] Reads plain-text and markdown as input;
Expand Down Expand Up @@ -83,7 +83,7 @@ The boogeyman wrote all changes to the **master server**. Thus, the slaves
were read-only copies of master. But not to worry, he was a cripple.
```

Then, run **alex** on `example.md`:
Now, run **alex** on `example.md`:

```sh
$ alex example.md
Expand Down Expand Up @@ -114,7 +114,7 @@ See `$ alex --help` for more information.
$ npm install alex --save
```

**alex** is also as an AMD, CommonJS, and globals module,
**alex** is also available as an AMD, CommonJS, and globals module,
[uncompressed and compressed][releases].

### `alex(value[, allow])`
Expand Down

0 comments on commit e94f747

Please sign in to comment.