Skip to content

Commit e99de2a

Browse files
committed
Refactor docs
1 parent 8fdb90c commit e99de2a

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

readme.md

+15-9
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-script-supporting
@@ -73,13 +73,16 @@ scriptSupporting({
7373
scriptSupporting({
7474
type: 'element',
7575
tagName: 'template',
76-
children: [{type: 'text', value: 'Delta'}]
76+
properties: {},
77+
children: [],
78+
content: {type: 'root', children: [{type: 'text', value: 'Delta'}]}
7779
}) // => true
7880
```
7981

8082
## API
8183

82-
This package exports the identifier [`scriptSupporting`][scriptsupporting].
84+
This package exports the identifier
85+
[`scriptSupporting`][api-script-supporting].
8386
There is no default export.
8487

8588
### `scriptSupporting(value)`
@@ -103,10 +106,13 @@ It exports no additional types.
103106

104107
## Compatibility
105108

106-
Projects maintained by the unified collective are compatible with all maintained
109+
Projects maintained by the unified collective are compatible with maintained
107110
versions of Node.js.
108-
As of now, that is Node.js 14.14+ and 16.0+.
109-
Our projects sometimes work with older versions, but this is not guaranteed.
111+
112+
When we cut a new major release, we drop support for unmaintained versions of
113+
Node.
114+
This means we try to keep the current release line,
115+
`hast-util-script-supporting@^2`, compatible with Node.js 12.
110116

111117
## Security
112118

@@ -174,9 +180,9 @@ abide by its terms.
174180

175181
[downloads]: https://www.npmjs.com/package/hast-util-script-supporting
176182

177-
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-script-supporting.svg
183+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-script-supporting
178184

179-
[size]: https://bundlephobia.com/result?p=hast-util-script-supporting
185+
[size]: https://bundlejs.com/?q=hast-util-script-supporting
180186

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

@@ -216,4 +222,4 @@ abide by its terms.
216222

217223
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
218224

219-
[scriptsupporting]: #scriptsupportingvalue
225+
[api-script-supporting]: #scriptsupportingvalue

0 commit comments

Comments
 (0)