Skip to content

Commit

Permalink
Refactor docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jun 29, 2023
1 parent bc4b907 commit a54914e
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ On the other hand, this is quite powerful and fast enough for many other cases.
## Install

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

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

## API

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

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

## Compatibility

Projects maintained by the unified collective are compatible with all maintained
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
Our projects sometimes work with older versions, but this is not guaranteed.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, `unist-util-select@^5`,
compatible with Node.js 12.

## Related

Expand Down Expand Up @@ -324,9 +328,9 @@ abide by its terms.

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

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

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

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

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

[hast-util-select]: https://github.com/syntax-tree/hast-util-select

[api-matches]: #matchesselector-node

[api-select]: #selectselector-tree

[api-select-all]: #selectallselector-tree

0 comments on commit a54914e

Please sign in to comment.