Skip to content

Commit e832993

Browse files
committed
Refactor docs
1 parent 075e725 commit e832993

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-phrasing
@@ -96,7 +96,7 @@ phrasing({type: 'text', value: 'Delta'})
9696

9797
## API
9898

99-
This package exports the identifier [`phrasing`][phrasing].
99+
This package exports the identifier [`phrasing`][api-phrasing].
100100
There is no default export.
101101

102102
### `phrasing(value)`
@@ -119,10 +119,13 @@ It exports no additional types.
119119

120120
## Compatibility
121121

122-
Projects maintained by the unified collective are compatible with all maintained
122+
Projects maintained by the unified collective are compatible with maintained
123123
versions of Node.js.
124-
As of now, that is Node.js 14.14+ and 16.0+.
125-
Our projects sometimes work with older versions, but this is not guaranteed.
124+
125+
When we cut a new major release, we drop support for unmaintained versions of
126+
Node.
127+
This means we try to keep the current release line, `hast-util-phrasing@^2`,
128+
compatible with Node.js 12.
126129

127130
## Security
128131

@@ -190,9 +193,9 @@ abide by its terms.
190193

191194
[downloads]: https://www.npmjs.com/package/hast-util-phrasing
192195

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

195-
[size]: https://bundlephobia.com/result?p=hast-util-phrasing
198+
[size]: https://bundlejs.com/?q=hast-util-phrasing
196199

197200
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
198201

@@ -232,4 +235,4 @@ abide by its terms.
232235

233236
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
234237

235-
[phrasing]: #phrasingvalue
238+
[api-phrasing]: #phrasingvalue

0 commit comments

Comments
 (0)