Skip to content

Commit a79ce81

Browse files
committed
Refactor docs
1 parent af60251 commit a79ce81

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
@@ -46,7 +46,7 @@ of does the inverse: it takes a node and gets its text.
4646
## Install
4747

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

5151
```sh
5252
npm install hast-util-from-text
@@ -114,7 +114,7 @@ Yields:
114114

115115
## API
116116

117-
This package exports the identifier [`fromText`][fromtext].
117+
This package exports the identifier [`fromText`][api-from-text].
118118
There is no default export.
119119

120120
### `fromText(node[, value])`
@@ -151,10 +151,13 @@ It exports no additional types.
151151

152152
## Compatibility
153153

154-
Projects maintained by the unified collective are compatible with all maintained
154+
Projects maintained by the unified collective are compatible with maintained
155155
versions of Node.js.
156-
As of now, that is Node.js 14.14+ and 16.0+.
157-
Our projects sometimes work with older versions, but this is not guaranteed.
156+
157+
When we cut a new major release, we drop support for unmaintained versions of
158+
Node.
159+
This means we try to keep the current release line, `hast-util-from-text@^2`,
160+
compatible with Node.js 12.
158161

159162
## Security
160163

@@ -202,9 +205,9 @@ abide by its terms.
202205

203206
[downloads]: https://www.npmjs.com/package/hast-util-from-text
204207

205-
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-from-text.svg
208+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-from-text
206209

207-
[size]: https://bundlephobia.com/result?p=hast-util-from-text
210+
[size]: https://bundlejs.com/?q=hast-util-from-text
208211

209212
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
210213

@@ -248,4 +251,4 @@ abide by its terms.
248251

249252
[hast-util-to-text]: https://github.com/syntax-tree/hast-util-to-text
250253

251-
[fromtext]: #fromtextnode-value
254+
[api-from-text]: #fromtextnode-value

0 commit comments

Comments
 (0)