Skip to content

Commit a199a83

Browse files
committed
Refactor docs
1 parent a4a72c1 commit a199a83

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

readme.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ node when working with xast (XML).
4040
## Install
4141

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

4545
```sh
4646
npm install xast-util-to-string
@@ -89,7 +89,7 @@ A Christmas CarolCharles Dickens
8989

9090
## API
9191

92-
This package exports the identifier [`toString`][tostring].
92+
This package exports the identifier [`toString`][api-to-string].
9393
There is no default export.
9494

9595
### `toString(node)`
@@ -112,10 +112,13 @@ It exports no additional types.
112112

113113
## Compatibility
114114

115-
Projects maintained by the unified collective are compatible with all maintained
115+
Projects maintained by the unified collective are compatible with maintained
116116
versions of Node.js.
117-
As of now, that is Node.js 14.14+ and 16.0+.
118-
Our projects sometimes work with older versions, but this is not guaranteed.
117+
118+
When we cut a new major release, we drop support for unmaintained versions of
119+
Node.
120+
This means we try to keep the current release line, `xast-util-to-string@^2`,
121+
compatible with Node.js 12.
119122

120123
## Security
121124

@@ -163,9 +166,9 @@ abide by its terms.
163166

164167
[downloads]: https://www.npmjs.com/package/xast-util-to-string
165168

166-
[size-badge]: https://img.shields.io/bundlephobia/minzip/xast-util-to-string.svg
169+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=xast-util-to-string
167170

168-
[size]: https://bundlephobia.com/result?p=xast-util-to-string
171+
[size]: https://bundlejs.com/?q=xast-util-to-string
169172

170173
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
171174

@@ -215,4 +218,4 @@ abide by its terms.
215218

216219
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
217220

218-
[tostring]: #tostringnode
221+
[api-to-string]: #tostringnode

0 commit comments

Comments
 (0)