Skip to content

Commit c9cb29b

Browse files
committed
Refactor prose
1 parent 90b4d85 commit c9cb29b

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

readme.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,22 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

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.
1313

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][].
1615
17-
## Installation
16+
## Install
1817

1918
[npm][]:
2019

21-
```bash
20+
```sh
2221
npm install nlcst-emoticon-modifier
2322
```
2423

2524
## Usage
2625

27-
```javascript
26+
```js
2827
var modifier = require('nlcst-emoticon-modifier')
2928
var inspect = require('unist-util-inspect')
3029
var english = require('parse-english')
@@ -60,21 +59,23 @@ SentenceNode[10]
6059

6160
### `emoticon(sentence)`
6261

63-
Classify plain-text ASCII [**emoticon**][emoticon]s as `EmoticonNode`s.
62+
Classify plain-text ASCII [emoticon][]s as `EmoticonNode`s.
6463

6564
##### Parameters
6665

6766
###### `sentence`
6867

69-
Node to process ([`NLCSTSentenceNode`][sentence]).
68+
Node to process ([`Sentence`][sentence]).
7069

7170
## Contribute
7271

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
7473
started.
74+
See [`support.md`][support] for ways to get help.
7575

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.
7879

7980
## License
8081

@@ -114,12 +115,16 @@ repository, organisation, or community you agree to abide by its terms.
114115

115116
[author]: https://wooorm.com
116117

117-
[retext-emoji]: https://github.com/wooorm/retext-emoji
118+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
118119

119-
[sentence]: https://github.com/syntax-tree/nlcst#paragrap
120+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
120121

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
122125

123-
[contributing]: https://github.com/syntax-tree/nlcst/blob/master/contributing.md
126+
[nlcst]: https://github.com/syntax-tree/nlcst
124127

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

Comments
 (0)