Skip to content

Commit 9298ff6

Browse files
committed
Refactor docs
1 parent 5405e76 commit 9298ff6

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

readme.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
1-
# nlcst-emoticon-modifier [![Build Status](https://img.shields.io/travis/wooorm/nlcst-emoticon-modifier.svg)](https://travis-ci.org/wooorm/nlcst-emoticon-modifier) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/nlcst-emoticon-modifier.svg)](https://codecov.io/github/wooorm/nlcst-emoticon-modifier)
1+
# nlcst-emoticon-modifier [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
22

3-
Classify plain-text ASCII [**emoticon**](https://github.com/wooorm/emoticon)s
3+
Classify plain-text ASCII [**emoticon**][emoticon]s
44
as `EmoticonNode`s.
55

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

109
## Installation
1110

12-
[npm](https://docs.npmjs.com/cli/install):
11+
[npm][]:
1312

1413
```bash
1514
npm install nlcst-emoticon-modifier
1615
```
1716

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-
2317
## Usage
2418

2519
```javascript
@@ -55,27 +49,36 @@ SentenceNode[10]
5549

5650
## API
5751

58-
### emoticonModifier(sentence)
52+
### `emoticon(sentence)`
5953

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
6257

63-
**Parameters**
58+
* `sentence` ([`NLCSTSentenceNode`][sentence]).
6459

65-
* `sentence` ([`NLCSTSentenceNode`](https://github.com/wooorm/nlcst#sentencenode))
66-
— Node with children.
60+
## License
6761

68-
**Throws**
62+
[MIT][license] © [Titus Wormer][author]
6963

70-
* `Error` — When not given a parent node.
64+
<!-- Definitions -->
7165

72-
## Related
66+
[travis-badge]: https://img.shields.io/travis/wooorm/nlcst-emoticon-modifier.svg
7367

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
7869

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
8083

81-
[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
84+
[emoticon]: https://github.com/wooorm/emoticon

0 commit comments

Comments
 (0)