Skip to content

Commit a54914e

Browse files
committed
Refactor docs
1 parent bc4b907 commit a54914e

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

readme.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ On the other hand, this is quite powerful and fast enough for many other cases.
5454
## Install
5555

5656
This package is [ESM only][esm].
57-
In Node.js (version 14.14+, 16.0+), install with [npm][]:
57+
In Node.js (version 16+), install with [npm][]:
5858

5959
```sh
6060
npm install unist-util-select
@@ -101,7 +101,8 @@ console.log(selectAll('code ~ :nth-child(even)', tree))
101101

102102
## API
103103

104-
This package exports the identifiers `matches`, `select`, and `selectAll`.
104+
This package exports the identifiers [`matches`][api-matches],
105+
[`select`][api-select], and [`selectAll`][api-select-all].
105106
There is no default export.
106107

107108
### `matches(selector, node)`
@@ -280,10 +281,13 @@ It exports no additional types.
280281

281282
## Compatibility
282283

283-
Projects maintained by the unified collective are compatible with all maintained
284+
Projects maintained by the unified collective are compatible with maintained
284285
versions of Node.js.
285-
As of now, that is Node.js 14.14+ and 16.0+.
286-
Our projects sometimes work with older versions, but this is not guaranteed.
286+
287+
When we cut a new major release, we drop support for unmaintained versions of
288+
Node.
289+
This means we try to keep the current release line, `unist-util-select@^5`,
290+
compatible with Node.js 12.
287291

288292
## Related
289293

@@ -324,9 +328,9 @@ abide by its terms.
324328

325329
[downloads]: https://www.npmjs.com/package/unist-util-select
326330

327-
[size-badge]: https://img.shields.io/bundlephobia/minzip/unist-util-select.svg
331+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=unist-util-select
328332

329-
[size]: https://bundlephobia.com/result?p=unist-util-select
333+
[size]: https://bundlejs.com/?q=unist-util-select
330334

331335
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
332336

@@ -367,3 +371,9 @@ abide by its terms.
367371
[hast]: https://github.com/syntax-tree/hast
368372

369373
[hast-util-select]: https://github.com/syntax-tree/hast-util-select
374+
375+
[api-matches]: #matchesselector-node
376+
377+
[api-select]: #selectselector-tree
378+
379+
[api-select-all]: #selectallselector-tree

0 commit comments

Comments
 (0)