Skip to content

Commit

Permalink
Add FAQ to readme.md
Browse files Browse the repository at this point in the history
Closes GH-29.
  • Loading branch information
wooorm committed Sep 8, 2015
1 parent e023736 commit 3690753
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,17 @@ $ npm install alex --global

* [alex(value)](#alexvalue)

* [Support](#support)

* [Integrations](#integrations)

* [Support](#support)

* [Workflow](#workflow)

* [FAQ](#faq)

* [Why is this named alex?](#why-is-this-named-alex)
* [Alex didn’t check ‘X’, this is dumb!](#alex-didnt-check-x-this-is-dumb)

* [Contributing](#contributing)

* [License](#license)
Expand Down Expand Up @@ -92,7 +97,7 @@ See `$ alex --help` for more information.
[npm](https://docs.npmjs.com/cli/install):

```sh
$ npm install alex
$ npm install alex --save
```

**alex** is also available for [bower](http://bower.io/#install-packages) and
Expand Down Expand Up @@ -127,6 +132,12 @@ alex('We’ve confirmed his identity.').messages;
in its [`messages`](https://github.com/wooorm/vfile#vfilemessages) property, as
demonstrated in the example above, as it holds the possible violations.

## Integrations

* Atom — [wooorm/atom-linter-alex](https://github.com/wooorm/atom-linter-alex)
* Sublime — [sindresorhus/SublimeLinter-contrib-alex](https://github.com/sindresorhus/SublimeLinter-contrib-alex)
* Gulp — [dustinspecker/gulp-alex](https://github.com/dustinspecker/gulp-alex)

## Support

**alex** checks for many patterns of English language, and warns for:
Expand All @@ -146,12 +157,6 @@ demonstrated in the example above, as it holds the possible violations.
**alex** ignores words meant literally, so `“he”`, `He — ...`, and [the like](https://github.com/wooorm/nlcst-is-literal#isliteralparent-index)
are not warned about

## Integrations

* Atom — [wooorm/atom-linter-alex](https://github.com/wooorm/atom-linter-alex)
* Sublime — [sindresorhus/SublimeLinter-contrib-alex](https://github.com/sindresorhus/SublimeLinter-contrib-alex)
* Gulp — [dustinspecker/gulp-alex](https://github.com/dustinspecker/gulp-alex)

## Workflow

The recommended workflow is to add **alex** locally and to run it with your
Expand All @@ -175,6 +180,21 @@ as follows:
}
```

## FAQ

<!--lint disable no-heading-punctuation-->

### Why is this named alex?

It’s a nice androgynous/unisex name, it was free on npm, I like it! :smile:

### Alex didn’t check ‘X’, this is dumb!

This is not a question, and I don’t agree. See
[CONTRIBUTING.md](CONTRIBUTING.md) on how to get ‘X’ checked by alex.

<!--lint enable no-heading-punctuation-->

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down

0 comments on commit 3690753

Please sign in to comment.