Skip to content

Commit e66b02d

Browse files
committed
Refactor docs
1 parent 43a5c73 commit e66b02d

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

readme.md

+23-17
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
1-
# nlcst-affix-emoticon-modifier [![Build Status](https://img.shields.io/travis/wooorm/nlcst-affix-emoticon-modifier.svg)](https://travis-ci.org/wooorm/nlcst-affix-emoticon-modifier) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/nlcst-affix-emoticon-modifier.svg)](https://codecov.io/github/wooorm/nlcst-affix-emoticon-modifier)
1+
# nlcst-affix-emoticon-modifier [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
22

33
Move initial emoticons into the previous sentence. Useful because many people
44
place an emoticon, representing emotion related to the previous sentence, after
55
a terminal marker. :unamused:
66

7-
Implemented by [retext-emoji](https://github.com/wooorm/retext-emoji), but
8-
separated for use by standalone (non-[retext](https://github.com/wooorm/retext))
9-
processing.
7+
Implemented by [**retext-emoji**][retext-emoji], but separated for use by
8+
standalone (non-retext) processing.
109

1110
## Installation
1211

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

1514
```bash
1615
npm install nlcst-affix-emoticon-modifier
1716
```
1817

1918
## Usage
2019

21-
```javascript
20+
```js
2221
var affixEmoticon = require('nlcst-affix-emoticon-modifier');
2322
var emoticon = require('nlcst-emoticon-modifier');
2423
var inspect = require('unist-util-inspect');
@@ -59,25 +58,32 @@ RootNode[1]
5958

6059
## API
6160

62-
### affixEmoticonModifier(paragraph)
61+
### `affixEmoticon(paragraph)`
6362

6463
Merge affix emoticons into the previous sentence.
6564

66-
**Parameters**
65+
###### Parameters
6766

6867
* `paragraph` ([`NLCSTParagraphNode`](https://github.com/wooorm/nlcst#paragraphnode)).
6968

70-
**Throws**
69+
## License
7170

72-
* `Error` — When not given a parent node.
71+
[MIT][license] © [Titus Wormer][author]
7372

74-
## Related
73+
<!-- Definitions -->
7574

76-
* [nlcst](https://github.com/wooorm/nlcst);
77-
* [nlcst-emoji-modifier](https://github.com/wooorm/nlcst-emoji-modifier);
78-
* [nlcst-emoticon-modifier](https://github.com/wooorm/nlcst-emoticon-modifier);
79-
* [retext](https://github.com/wooorm/retext).
75+
[travis-badge]: https://img.shields.io/travis/wooorm/nlcst-affix-emoticon-modifier.svg
8076

81-
## License
77+
[travis]: https://travis-ci.org/wooorm/nlcst-affix-emoticon-modifier
78+
79+
[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/nlcst-affix-emoticon-modifier.svg
80+
81+
[codecov]: https://codecov.io/github/wooorm/nlcst-affix-emoticon-modifier
82+
83+
[npm]: https://docs.npmjs.com/cli/install
84+
85+
[license]: LICENSE
86+
87+
[author]: http://wooorm.com
8288

83-
[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
89+
[retext-emoji]: https://github.com/wooorm/retext-emoji

0 commit comments

Comments
 (0)