Skip to content

Commit 88de797

Browse files
committed
Refactor docs
1 parent 0227f1a commit 88de797

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

Diff for: readme.md

+21-17
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You can instead use [`unist-builder`][u] when creating any unist nodes and
5151
## Install
5252

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

5656
```sh
5757
npm install hastscript
@@ -146,7 +146,7 @@ Yields:
146146

147147
## API
148148

149-
This package exports the identifiers [`h`][h] and [`s`][s].
149+
This package exports the identifiers [`h`][api-h] and [`s`][api-s].
150150
There is no default export.
151151

152152
The export map supports the automatic JSX runtime.
@@ -177,15 +177,15 @@ When nullish, builds a [`Root`][root] instead.
177177

178178
###### `properties`
179179

180-
Properties of the element ([`Properties`][properties], optional).
180+
Properties of the element ([`Properties`][api-properties], optional).
181181

182182
###### `children`
183183

184-
Children of the node ([`Child`][child] or `Array<Child>`, optional).
184+
Children of the node ([`Child`][api-child] or `Array<Child>`, optional).
185185

186186
##### Returns
187187

188-
Created tree ([`Result`][result]).
188+
Created tree ([`Result`][api-result]).
189189

190190
[`Element`][element] when a `selector` is passed, otherwise [`Root`][root].
191191

@@ -302,15 +302,19 @@ console.log(
302302
## Types
303303
304304
This package is fully typed with [TypeScript][].
305-
It exports the additional types [`Child`][child], [`Properties`][properties],
306-
and [`Result`][result].
305+
It exports the additional types [`Child`][api-child],
306+
[`Properties`][api-properties], and
307+
[`Result`][api-result].
307308
308309
## Compatibility
309310
310-
Projects maintained by the unified collective are compatible with all maintained
311+
Projects maintained by the unified collective are compatible with maintained
311312
versions of Node.js.
312-
As of now, that is Node.js 14.14+ and 16.0+.
313-
Our projects sometimes work with older versions, but this is not guaranteed.
313+
314+
When we cut a new major release, we drop support for unmaintained versions of
315+
Node.
316+
This means we try to keep the current release line, `hastscript@^7`,
317+
compatible with Node.js 12.
314318
315319
## Security
316320
@@ -405,9 +409,9 @@ abide by its terms.
405409

406410
[downloads]: https://www.npmjs.com/package/hastscript
407411

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

410-
[size]: https://bundlephobia.com/result?p=hastscript
414+
[size]: https://bundlejs.com/?q=hastscript
411415

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

@@ -457,12 +461,12 @@ abide by its terms.
457461

458462
[hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize
459463

460-
[h]: #hselector-properties-children
464+
[api-h]: #hselector-properties-children
461465

462-
[s]: #sselector-properties-children
466+
[api-s]: #sselector-properties-children
463467

464-
[child]: #child
468+
[api-child]: #child
465469

466-
[properties]: #properties-1
470+
[api-properties]: #properties-1
467471

468-
[result]: #result
472+
[api-result]: #result

0 commit comments

Comments
 (0)