|
1 |
| -# nlcst-emoticon-modifier [](https://travis-ci.org/wooorm/nlcst-emoticon-modifier) [](https://codecov.io/github/wooorm/nlcst-emoticon-modifier) |
| 1 | +# nlcst-emoticon-modifier [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov] |
2 | 2 |
|
3 |
| -Classify plain-text ASCII [**emoticon**](https://github.com/wooorm/emoticon)s |
| 3 | +Classify plain-text ASCII [**emoticon**][emoticon]s |
4 | 4 | as `EmoticonNode`s.
|
5 | 5 |
|
6 |
| -Implemented by [retext-emoji](https://github.com/wooorm/retext-emoji), but |
7 |
| -separated for use by standalone (non-[retext](https://github.com/wooorm/retext)) |
8 |
| -processing. |
| 6 | +Implemented by [**retext-emoji**][retext-emoji], but separated for use by |
| 7 | +standalone (non-retext) processing. |
9 | 8 |
|
10 | 9 | ## Installation
|
11 | 10 |
|
12 |
| -[npm](https://docs.npmjs.com/cli/install): |
| 11 | +[npm][]: |
13 | 12 |
|
14 | 13 | ```bash
|
15 | 14 | npm install nlcst-emoticon-modifier
|
16 | 15 | ```
|
17 | 16 |
|
18 |
| -**nlcst-emoticon-modifier** is also available for [bower](http://bower.io/#install-packages), |
19 |
| -[component](https://github.com/componentjs/component), and |
20 |
| -[duo](http://duojs.org/#getting-started), and as an AMD, CommonJS, and globals |
21 |
| -module, [uncompressed](nlcst-emoticon-modifier.js) and [compressed](nlcst-emoticon-modifier.min.js). |
22 |
| - |
23 | 17 | ## Usage
|
24 | 18 |
|
25 | 19 | ```javascript
|
@@ -55,27 +49,36 @@ SentenceNode[10]
|
55 | 49 |
|
56 | 50 | ## API
|
57 | 51 |
|
58 |
| -### emoticonModifier(sentence) |
| 52 | +### `emoticon(sentence)` |
59 | 53 |
|
60 |
| -Classify plain-text ASCII [**emoticon**](https://github.com/wooorm/emoticon)s |
61 |
| -as `EmoticonNode`s. |
| 54 | +Classify plain-text ASCII [**emoticon**][emoticon]s as `EmoticonNode`s. |
| 55 | + |
| 56 | +###### Parameters |
62 | 57 |
|
63 |
| -**Parameters** |
| 58 | +* `sentence` ([`NLCSTSentenceNode`][sentence]). |
64 | 59 |
|
65 |
| -* `sentence` ([`NLCSTSentenceNode`](https://github.com/wooorm/nlcst#sentencenode)) |
66 |
| - — Node with children. |
| 60 | +## License |
67 | 61 |
|
68 |
| -**Throws** |
| 62 | +[MIT][license] © [Titus Wormer][author] |
69 | 63 |
|
70 |
| -* `Error` — When not given a parent node. |
| 64 | +<!-- Definitions --> |
71 | 65 |
|
72 |
| -## Related |
| 66 | +[travis-badge]: https://img.shields.io/travis/wooorm/nlcst-emoticon-modifier.svg |
73 | 67 |
|
74 |
| -* [nlcst](https://github.com/wooorm/nlcst); |
75 |
| -* [nlcst-emoji-modifier](https://github.com/wooorm/nlcst-emoji-modifier); |
76 |
| -* [nlcst-affix-emoticon-modifier](https://github.com/wooorm/nlcst-affix-emoticon-modifier); |
77 |
| -* [retext](https://github.com/wooorm/retext). |
| 68 | +[travis]: https://travis-ci.org/wooorm/nlcst-emoticon-modifier |
78 | 69 |
|
79 |
| -## License |
| 70 | +[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/nlcst-emoticon-modifier.svg |
| 71 | + |
| 72 | +[codecov]: https://codecov.io/github/wooorm/nlcst-emoticon-modifier |
| 73 | + |
| 74 | +[npm]: https://docs.npmjs.com/cli/install |
| 75 | + |
| 76 | +[license]: LICENSE |
| 77 | + |
| 78 | +[author]: http://wooorm.com |
| 79 | + |
| 80 | +[retext-emoji]: https://github.com/wooorm/retext-emoji |
| 81 | + |
| 82 | +[sentence]: https://github.com/wooorm/nlcst#paragraphnode |
80 | 83 |
|
81 |
| -[MIT](LICENSE) © [Titus Wormer](http://wooorm.com) |
| 84 | +[emoticon]: https://github.com/wooorm/emoticon |
0 commit comments