# match-words [![NPM version](https://img.shields.io/npm/v/match-words.svg?style=flat)](https://www.npmjs.com/package/match-words) [![NPM monthly downloads](https://img.shields.io/npm/dm/match-words.svg?style=flat)](https://npmjs.org/package/match-words)  [![NPM total downloads](https://img.shields.io/npm/dt/match-words.svg?style=flat)](https://npmjs.org/package/match-words) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/match-words.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/match-words)

> Match the words in a string. Support for english, CJK and Cyrillic.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save match-words
```

## Usage

```js
var matchWords = require('word-regex');

matchWords('match words.');
//=> ['match', 'words']
matchWords('match words, again.');
//=> ['match', 'words', 'again']
```

## About

### Related projects

* [is-whitespace](https://www.npmjs.com/package/is-whitespace): Returns true if the value passed is all whitespace. | [homepage](https://github.com/jonschlinkert/is-whitespace "Returns true if the value passed is all whitespace.")
* [whitespace-regex](https://www.npmjs.com/package/whitespace-regex): Regular expression for matching the whitespace in a string. | [homepage](https://github.com/regexps/whitespace-regex "Regular expression for matching the whitespace in a string.")
* [word-regex](https://www.npmjs.com/package/word-regex): Regular expression for matching words in a string. Support for english, CJK and Cyrillic. | [homepage](https://github.com/regexps/word-regex "Regular expression for matching words in a string. Support for english, CJK and Cyrillic.")
* [wordcount](https://www.npmjs.com/package/wordcount): Count the words in a string. Support for english, CJK and Cyrillic. | [homepage](https://github.com/jonschlinkert/wordcount "Count the words in a string. Support for english, CJK and Cyrillic.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_

To generate the readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-generate-readme && verb
```

### Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

### License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/match-words/blob/master/LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 22, 2016._