|
8 | 8 | [![Backers][backers-badge]][collective]
|
9 | 9 | [![Chat][chat-badge]][chat]
|
10 | 10 |
|
11 |
| -Classify plain-text ASCII [**emoticon**][emoticon]s |
12 |
| -as `EmoticonNode`s. |
| 11 | +[**nlcst**][nlcst] utility to classify plain-text ASCII [emoticon][]s as |
| 12 | +`EmoticonNode`s. |
13 | 13 |
|
14 |
| -Implemented by [**retext-emoji**][retext-emoji], but separated for use by |
15 |
| -standalone (non-retext) processing. |
| 14 | +> **Note**: You probably want to use [retext-emoji][]. |
16 | 15 |
|
17 |
| -## Installation |
| 16 | +## Install |
18 | 17 |
|
19 | 18 | [npm][]:
|
20 | 19 |
|
21 |
| -```bash |
| 20 | +```sh |
22 | 21 | npm install nlcst-emoticon-modifier
|
23 | 22 | ```
|
24 | 23 |
|
25 | 24 | ## Usage
|
26 | 25 |
|
27 |
| -```javascript |
| 26 | +```js |
28 | 27 | var modifier = require('nlcst-emoticon-modifier')
|
29 | 28 | var inspect = require('unist-util-inspect')
|
30 | 29 | var english = require('parse-english')
|
@@ -60,21 +59,23 @@ SentenceNode[10]
|
60 | 59 |
|
61 | 60 | ### `emoticon(sentence)`
|
62 | 61 |
|
63 |
| -Classify plain-text ASCII [**emoticon**][emoticon]s as `EmoticonNode`s. |
| 62 | +Classify plain-text ASCII [emoticon][]s as `EmoticonNode`s. |
64 | 63 |
|
65 | 64 | ##### Parameters
|
66 | 65 |
|
67 | 66 | ###### `sentence`
|
68 | 67 |
|
69 |
| -Node to process ([`NLCSTSentenceNode`][sentence]). |
| 68 | +Node to process ([`Sentence`][sentence]). |
70 | 69 |
|
71 | 70 | ## Contribute
|
72 | 71 |
|
73 |
| -See [`contributing.md` in `syntax-tree/nlcst`][contributing] for ways to get |
| 72 | +See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get |
74 | 73 | started.
|
| 74 | +See [`support.md`][support] for ways to get help. |
75 | 75 |
|
76 |
| -This organisation has a [Code of Conduct][coc]. By interacting with this |
77 |
| -repository, organisation, or community you agree to abide by its terms. |
| 76 | +This project has a [Code of Conduct][coc]. |
| 77 | +By interacting with this repository, organisation, or community you agree to |
| 78 | +abide by its terms. |
78 | 79 |
|
79 | 80 | ## License
|
80 | 81 |
|
@@ -114,12 +115,16 @@ repository, organisation, or community you agree to abide by its terms.
|
114 | 115 |
|
115 | 116 | [author]: https://wooorm.com
|
116 | 117 |
|
117 |
| -[retext-emoji]: https://github.com/wooorm/retext-emoji |
| 118 | +[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md |
118 | 119 |
|
119 |
| -[sentence]: https://github.com/syntax-tree/nlcst#paragrap |
| 120 | +[support]: https://github.com/syntax-tree/.github/blob/master/support.md |
120 | 121 |
|
121 |
| -[emoticon]: https://github.com/wooorm/emoticon |
| 122 | +[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md |
| 123 | + |
| 124 | +[retext-emoji]: https://github.com/retextjs/retext-emoji |
122 | 125 |
|
123 |
| -[contributing]: https://github.com/syntax-tree/nlcst/blob/master/contributing.md |
| 126 | +[nlcst]: https://github.com/syntax-tree/nlcst |
124 | 127 |
|
125 |
| -[coc]: https://github.com/syntax-tree/nlcst/blob/master/code-of-conduct.md |
| 128 | +[sentence]: https://github.com/syntax-tree/nlcst#sentence |
| 129 | + |
| 130 | +[emoticon]: https://github.com/wooorm/emoticon |
0 commit comments