Skip to content

Commit 15445f3

Browse files
committed
Refactor prose
1 parent 2206f53 commit 15445f3

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

readme.md

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

11-
Stringify [NLCST][].
11+
[**nlcst**][nlcst] utility to stringify a node.
1212

13-
## Installation
13+
## Install
1414

1515
[npm][]:
1616

17-
```bash
17+
```sh
1818
npm install nlcst-to-string
1919
```
2020

2121
## Usage
2222

23-
```javascript
23+
```js
2424
var toString = require('nlcst-to-string')
2525

2626
console.log(
@@ -39,25 +39,27 @@ console.log(
3939

4040
### `toString(node[, separator])`
4141

42-
Stringify the given [NLCST][] node (or list of nodes).
42+
Stringify the given [nlcst][] node (or list of nodes).
4343

4444
###### Parameters
4545

46-
* `node` ([`NLCSTNode`][nlcst] or `Array.<NLCSTNode>`)
46+
* `node` ([`Node`][node] or `Array.<Node>`)
4747
* `separator` (`string`, optional, default: `''`)
48-
— Value to separate each item with
48+
— Value to delimit each item
4949

5050
###### Returns
5151

5252
`string`.
5353

5454
## Contribute
5555

56-
See [`contributing.md` in `syntax-tree/nlcst`][contributing] for ways to get
56+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
5757
started.
58+
See [`support.md`][support] for ways to get help.
5859

59-
This organisation has a [Code of Conduct][coc]. By interacting with this
60-
repository, organisation, or community you agree to abide by its terms.
60+
This project has a [Code of Conduct][coc].
61+
By interacting with this repository, organisation, or community you agree to
62+
abide by its terms.
6163

6264
## License
6365

@@ -97,8 +99,12 @@ repository, organisation, or community you agree to abide by its terms.
9799

98100
[author]: https://wooorm.com
99101

100-
[nlcst]: https://github.com/syntax-tree/nlcst
102+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
103+
104+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
101105

102-
[contributing]: https://github.com/syntax-tree/nlcst/blob/master/contributing.md
106+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
107+
108+
[nlcst]: https://github.com/syntax-tree/nlcst
103109

104-
[coc]: https://github.com/syntax-tree/nlcst/blob/master/code-of-conduct.md
110+
[node]: https://github.com/syntax-tree/nlcst#nodes

0 commit comments

Comments
 (0)