Skip to content

Commit c43f6df

Browse files
committed
Refactor prose
1 parent 2569eec commit c43f6df

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

readme.md

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

11-
Check if an [NLCST][] node is meant literally. Useful if a tool wants to
12-
exclude these values possibly void of meaning.
11+
[**nlcst**][nlcst] utility to check if a node is meant literally.
1312

14-
As an example, a spell-checker could exclude these literal words, thus not
15-
warning about “monsieur”.
13+
Useful if a tool wants to exclude values that are possibly void of meaning.
14+
For example, a spell-checker could exclude these literal words, thus not warning
15+
about “monsieur”.
1616

17-
## Installation
17+
## Install
1818

1919
[npm][]:
2020

21-
```bash
21+
```sh
2222
npm install nlcst-is-literal
2323
```
2424

@@ -40,7 +40,7 @@ The word — quux — is meant as a literal.
4040

4141
And our script, `example.js`, looks as follows:
4242

43-
```javascript
43+
```js
4444
var vfile = require('to-vfile')
4545
var unified = require('unified')
4646
var english = require('retext-english')
@@ -49,6 +49,7 @@ var toString = require('nlcst-to-string')
4949
var literal = require('nlcst-is-literal')
5050

5151
var file = vfile.readSync('example.txt')
52+
5253
var tree = unified()
5354
.use(english)
5455
.parse(file)
@@ -87,11 +88,13 @@ For example, `foo` is literal in the following samples:
8788

8889
## Contribute
8990

90-
See [`contributing.md` in `syntax-tree/nlcst`][contributing] for ways to get
91+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
9192
started.
93+
See [`support.md`][support] for ways to get help.
9294

93-
This organisation has a [Code of Conduct][coc]. By interacting with this
94-
repository, organisation, or community you agree to abide by its terms.
95+
This project has a [Code of Conduct][coc].
96+
By interacting with this repository, organisation, or community you agree to
97+
abide by its terms.
9598

9699
## License
97100

@@ -131,8 +134,10 @@ repository, organisation, or community you agree to abide by its terms.
131134

132135
[author]: https://wooorm.com
133136

134-
[nlcst]: https://github.com/syntax-tree/nlcst
137+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
135138

136-
[contributing]: https://github.com/syntax-tree/nlcst/blob/master/contributing.md
139+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
137140

138-
[coc]: https://github.com/syntax-tree/nlcst/blob/master/code-of-conduct.md
141+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
142+
143+
[nlcst]: https://github.com/syntax-tree/nlcst

0 commit comments

Comments
 (0)