Skip to content

Commit 4dcbc94

Browse files
committed
Refactor prose
1 parent 6a27a39 commit 4dcbc94

File tree

1 file changed

+43
-21
lines changed

1 file changed

+43
-21
lines changed

readme.md

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
# hast-util-interactive [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
1+
# hast-util-interactive
22

3-
Check whether a [HAST node][hast] is [**interactive**][spec].
3+
[![Build][build-badge]][build]
4+
[![Coverage][coverage-badge]][coverage]
5+
[![Downloads][downloads-badge]][downloads]
6+
[![Size][size-badge]][size]
7+
[![Sponsors][sponsors-badge]][collective]
8+
[![Backers][backers-badge]][collective]
9+
[![Chat][chat-badge]][chat]
410

5-
## Installation
11+
Check whether a [**hast**][hast] node is [*interactive*][spec].
12+
13+
## Install
614

715
[npm][]:
816

9-
```bash
17+
```sh
1018
npm install hast-util-interactive
1119
```
1220

1321
## Usage
1422

15-
```javascript
23+
```js
1624
var interactive = require('hast-util-interactive')
1725

1826
interactive({
@@ -47,53 +55,67 @@ interactive({
4755

4856
###### Returns
4957

50-
`boolean` — Whether `node` is an [`Element`][element] categorised
51-
as [**interactive**][spec].
58+
`boolean` — Whether `node` is an [`Element`][element] categorised as
59+
[*interactive*][spec].
5260

5361
## Contribute
5462

55-
See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get
63+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
5664
started.
65+
See [`support.md`][support] for ways to get help.
5766

58-
This organisation has a [Code of Conduct][coc]. By interacting with this
59-
repository, organisation, or community you agree to abide by its terms.
67+
This project has a [Code of Conduct][coc].
68+
By interacting with this repository, organisation, or community you agree to
69+
abide by its terms.
6070

6171
## License
6272

6373
[MIT][license] © [Titus Wormer][author]
6474

6575
<!-- Definition -->
6676

67-
[build-badge]: https://img.shields.io/travis/syntax-tree/hast-util-interactive.svg
77+
[build-badge]: https://img.shields.io/travis/syntax-tree/unist-util-assert.svg
78+
79+
[build]: https://travis-ci.org/syntax-tree/unist-util-assert
80+
81+
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-assert.svg
82+
83+
[coverage]: https://codecov.io/github/syntax-tree/unist-util-assert
84+
85+
[downloads-badge]: https://img.shields.io/npm/dm/unist-util-assert.svg
86+
87+
[downloads]: https://www.npmjs.com/package/unist-util-assert
6888

69-
[build]: https://travis-ci.org/syntax-tree/hast-util-interactive
89+
[size-badge]: https://img.shields.io/bundlephobia/minzip/unist-util-assert.svg
7090

71-
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-interactive.svg
91+
[size]: https://bundlephobia.com/result?p=unist-util-assert
7292

73-
[coverage]: https://codecov.io/github/syntax-tree/hast-util-interactive
93+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
7494

75-
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-interactive.svg
95+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
7696

77-
[downloads]: https://www.npmjs.com/package/hast-util-interactive
97+
[collective]: https://opencollective.com/unified
7898

7999
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
80100

81-
[chat]: https://spectrum.chat/unified/rehype
101+
[chat]: https://spectrum.chat/unified/syntax-tree
82102

83103
[npm]: https://docs.npmjs.com/cli/install
84104

85105
[license]: license
86106

87107
[author]: https://wooorm.com
88108

109+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
110+
111+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
112+
113+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
114+
89115
[hast]: https://github.com/syntax-tree/hast
90116

91117
[node]: https://github.com/syntax-tree/unist#node
92118

93119
[element]: https://github.com/syntax-tree/hast#element
94120

95121
[spec]: https://html.spec.whatwg.org/#interactive-content
96-
97-
[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md
98-
99-
[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md

0 commit comments

Comments
 (0)