Skip to content

Commit e4f2348

Browse files
committed
Refactor prose
1 parent 92a73d4 commit e4f2348

File tree

1 file changed

+43
-20
lines changed

1 file changed

+43
-20
lines changed

readme.md

+43-20
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
1-
# hast-util-embedded [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
1+
# hast-util-embedded
22

3-
Check if a [node][] is an [**embedded**][spec] [element][].
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+
[**hast**][hast] utility to check if an [*element*][element] is
12+
[*embedded*][spec].
13+
14+
## Install
615

716
[npm][]:
817

9-
```bash
18+
```sh
1019
npm install hast-util-embedded
1120
```
1221

1322
## Usage
1423

15-
```javascript
24+
```js
1625
var embedded = require('hast-util-embedded')
1726

1827
// Given a non-embedded value:
@@ -36,50 +45,64 @@ embedded({
3645

3746
### `embedded(node)`
3847

39-
Check if the given value is an [**embedded**][spec] [element][].
48+
Check if `node` is an [*embedded*][spec] [*element*][element].
4049

4150
## Contribute
4251

43-
See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get
52+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
4453
started.
54+
See [`support.md`][support] for ways to get help.
4555

46-
This organisation has a [Code of Conduct][coc]. By interacting with this
47-
repository, organisation, or community you agree to abide by its terms.
56+
This project has a [Code of Conduct][coc].
57+
By interacting with this repository, organisation, or community you agree to
58+
abide by its terms.
4859

4960
## License
5061

5162
[MIT][license] © [Titus Wormer][author]
5263

5364
<!-- Definition -->
5465

55-
[build-badge]: https://img.shields.io/travis/syntax-tree/hast-util-embedded.svg
66+
[build-badge]: https://img.shields.io/travis/syntax-tree/unist-util-assert.svg
67+
68+
[build]: https://travis-ci.org/syntax-tree/unist-util-assert
69+
70+
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-assert.svg
71+
72+
[coverage]: https://codecov.io/github/syntax-tree/unist-util-assert
73+
74+
[downloads-badge]: https://img.shields.io/npm/dm/unist-util-assert.svg
5675

57-
[build]: https://travis-ci.org/syntax-tree/hast-util-embedded
76+
[downloads]: https://www.npmjs.com/package/unist-util-assert
5877

59-
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-embedded.svg
78+
[size-badge]: https://img.shields.io/bundlephobia/minzip/unist-util-assert.svg
6079

61-
[coverage]: https://codecov.io/github/syntax-tree/hast-util-embedded
80+
[size]: https://bundlephobia.com/result?p=unist-util-assert
6281

63-
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-embedded.svg
82+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
6483

65-
[downloads]: https://www.npmjs.com/package/hast-util-embedded
84+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
85+
86+
[collective]: https://opencollective.com/unified
6687

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

69-
[chat]: https://spectrum.chat/unified/rehype
90+
[chat]: https://spectrum.chat/unified/syntax-tree
7091

7192
[npm]: https://docs.npmjs.com/cli/install
7293

7394
[license]: license
7495

7596
[author]: https://wooorm.com
7697

77-
[node]: https://github.com/syntax-tree/unist#node
98+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
7899

79-
[element]: https://github.com/syntax-tree/hast#element
100+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
101+
102+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
80103

81104
[spec]: https://html.spec.whatwg.org/#embedded-content-2
82105

83-
[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md
106+
[hast]: https://github.com/syntax-tree/hast
84107

85-
[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md
108+
[element]: https://github.com/syntax-tree/hast#element

0 commit comments

Comments
 (0)