Skip to content

Commit 934f308

Browse files
committed
Refactor prose
1 parent a3a266e commit 934f308

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

readme.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,26 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

11-
Stringify [unist][unist] [`Position`][position]s or [`Point`][point]s.
11+
[**unist**][unist] utility to pretty print the positional information of a node.
1212

13-
## Installation
13+
## Install
1414

1515
[npm][]:
1616

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

2121
## Usage
2222

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

2626
// Point
2727
stringify({line: 2, column: 3}) // => '2:3'
2828

2929
// Position
30-
stringify({
31-
start: {line: 2},
32-
end: {line: 3}
33-
}) // => '2:1-3:1'
30+
stringify({start: {line: 2}, end: {line: 3}}) // => '2:1-3:1'
3431

3532
// Node
3633
stringify({
@@ -47,7 +44,8 @@ stringify({
4744

4845
### `stringifyPosition(node|position|point)`
4946

50-
Stringify one point, a position (start and end points), or a node’s position.
47+
Stringify one [point][], a [position][] (start and end [point][]s), or a node’s
48+
[positional information][positional-information].
5149

5250
###### Parameters
5351

@@ -68,11 +66,13 @@ An empty string (`''`) is returned if the given value is neither `node`,
6866

6967
## Contribute
7068

71-
See [`contributing.md` in `syntax-tree/unist`][contributing] for ways to get
69+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
7270
started.
71+
See [`support.md`][support] for ways to get help.
7372

74-
This organisation has a [Code of Conduct][coc]. By interacting with this
75-
repository, organisation, or community you agree to abide by its terms.
73+
This project has a [Code of Conduct][coc].
74+
By interacting with this repository, organisation, or community you agree to
75+
abide by its terms.
7676

7777
## License
7878

@@ -112,6 +112,12 @@ repository, organisation, or community you agree to abide by its terms.
112112

113113
[author]: https://wooorm.com
114114

115+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
116+
117+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
118+
119+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
120+
115121
[unist]: https://github.com/syntax-tree/unist
116122

117123
[node]: https://github.com/syntax-tree/unist#node
@@ -120,6 +126,4 @@ repository, organisation, or community you agree to abide by its terms.
120126

121127
[point]: https://github.com/syntax-tree/unist#point
122128

123-
[contributing]: https://github.com/syntax-tree/unist/blob/master/contributing.md
124-
125-
[coc]: https://github.com/syntax-tree/unist/blob/master/code-of-conduct.md
129+
[positional-information]: https://github.com/syntax-tree/unist#positional-information

0 commit comments

Comments
 (0)