Skip to content

Commit 74b9b40

Browse files
committed
Refactor docs
1 parent 85ce03b commit 74b9b40

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

readme.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ looking for!
3838
## Install
3939

4040
This package is [ESM only][esm].
41-
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
41+
In Node.js (version 16+), install with [npm][]:
4242

4343
```sh
4444
npm install hast-util-embedded
@@ -82,7 +82,7 @@ embedded({
8282

8383
## API
8484

85-
This package exports the identifier [`embedded`][embedded].
85+
This package exports the identifier [`embedded`][api-embedded].
8686
There is no default export.
8787

8888
### `embedded(value)`
@@ -108,10 +108,13 @@ It exports no additional types.
108108

109109
## Compatibility
110110

111-
Projects maintained by the unified collective are compatible with all maintained
111+
Projects maintained by the unified collective are compatible with maintained
112112
versions of Node.js.
113-
As of now, that is Node.js 14.14+ and 16.0+.
114-
Our projects sometimes work with older versions, but this is not guaranteed.
113+
114+
When we cut a new major release, we drop support for unmaintained versions of
115+
Node.
116+
This means we try to keep the current release line, `hast-util-embedded@^2`,
117+
compatible with Node.js 12.
115118

116119
## Security
117120

@@ -179,9 +182,9 @@ abide by its terms.
179182

180183
[downloads]: https://www.npmjs.com/package/hast-util-embedded
181184

182-
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-embedded.svg
185+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-embedded
183186

184-
[size]: https://bundlephobia.com/result?p=hast-util-embedded
187+
[size]: https://bundlejs.com/?q=hast-util-embedded
185188

186189
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
187190

@@ -221,4 +224,4 @@ abide by its terms.
221224

222225
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
223226

224-
[embedded]: #embeddedvalue
227+
[api-embedded]: #embeddedvalue

0 commit comments

Comments
 (0)