Skip to content

Commit b3347e4

Browse files
committed
Refactor prose
1 parent 6d13d3c commit b3347e4

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

readme.md

+19-20
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,35 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

11-
Check if a [**Unist**][unist] [node][] is [**generated**][spec].
11+
[**unist**][unist] utility to check if a [node][] is [*generated*][generated].
1212

13-
## Installation
13+
## Install
1414

1515
[npm][]:
1616

17-
```bash
17+
```sh
1818
npm install unist-util-generated
1919
```
2020

2121
## Usage
2222

23-
```javascript
23+
```js
2424
var generated = require('unist-util-generated')
2525

2626
generated({}) // => true
2727

28-
generated({
29-
position: {start: {}, end: {}}
30-
}) // => true
28+
generated({position: {start: {}, end: {}}}) // => true
3129

3230
generated({
33-
position: {
34-
start: {line: 1, column: 1},
35-
end: {line: 1, column: 2}
36-
}
31+
position: {start: {line: 1, column: 1}, end: {line: 1, column: 2}}
3732
}) // => false
3833
```
3934

4035
## API
4136

4237
### `generated(node)`
4338

44-
Detect if [`node`][node] is [**generated**][spec].
39+
Check if [`node`][node] is [*generated*][generated].
4540

4641
###### Parameters
4742

@@ -62,11 +57,13 @@ Detect if [`node`][node] is [**generated**][spec].
6257

6358
## Contribute
6459

65-
See [`contributing.md` in `syntax-tree/unist`][contributing] for ways to get
60+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
6661
started.
62+
See [`support.md`][support] for ways to get help.
6763

68-
This organisation has a [Code of Conduct][coc]. By interacting with this
69-
repository, organisation, or community you agree to abide by its terms.
64+
This project has a [Code of Conduct][coc].
65+
By interacting with this repository, organisation, or community you agree to
66+
abide by its terms.
7067

7168
## License
7269

@@ -106,12 +103,14 @@ repository, organisation, or community you agree to abide by its terms.
106103

107104
[author]: https://wooorm.com
108105

109-
[unist]: https://github.com/syntax-tree/unist
106+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
110107

111-
[node]: https://github.com/syntax-tree/unist#node
108+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
112109

113-
[spec]: https://github.com/syntax-tree/unist#location
110+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
114111

115-
[contributing]: https://github.com/syntax-tree/unist/blob/master/contributing.md
112+
[unist]: https://github.com/syntax-tree/unist
113+
114+
[node]: https://github.com/syntax-tree/unist#node
116115

117-
[coc]: https://github.com/syntax-tree/unist/blob/master/code-of-conduct.md
116+
[generated]: https://github.com/syntax-tree/unist#generated

0 commit comments

Comments
 (0)