Skip to content

Commit 1910681

Browse files
committed
Refactor docs
1 parent 3e6a3b5 commit 1910681

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

readme.md

Lines changed: 13 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-sectioning
@@ -73,10 +73,12 @@ sectioning({
7373
sectioning({
7474
type: 'element',
7575
tagName: 'article',
76+
properties: {},
7677
children: [
7778
{
7879
type: 'element',
7980
tagName: 'p',
81+
properties: {},
8082
children: [{type: 'text', value: 'Delta'}]
8183
}
8284
]
@@ -85,7 +87,7 @@ sectioning({
8587

8688
## API
8789

88-
This package exports the identifier [`sectioning`][sectioning].
90+
This package exports the identifier [`sectioning`][api-sectioning].
8991
There is no default export.
9092

9193
### `sectioning(value)`
@@ -109,10 +111,13 @@ It exports no additional types.
109111

110112
## Compatibility
111113

112-
Projects maintained by the unified collective are compatible with all maintained
114+
Projects maintained by the unified collective are compatible with maintained
113115
versions of Node.js.
114-
As of now, that is Node.js 14.14+ and 16.0+.
115-
Our projects sometimes work with older versions, but this is not guaranteed.
116+
117+
When we cut a new major release, we drop support for unmaintained versions of
118+
Node.
119+
This means we try to keep the current release line, `hast-util-sectioning@^2`,
120+
compatible with Node.js 12.
116121

117122
## Security
118123

@@ -180,9 +185,9 @@ abide by its terms.
180185

181186
[downloads]: https://www.npmjs.com/package/hast-util-sectioning
182187

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

185-
[size]: https://bundlephobia.com/result?p=hast-util-sectioning
190+
[size]: https://bundlejs.com/?q=hast-util-sectioning
186191

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

@@ -222,4 +227,4 @@ abide by its terms.
222227

223228
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
224229

225-
[sectioning]: #sectioningvalue
230+
[api-sectioning]: #sectioningvalue

0 commit comments

Comments
 (0)