Skip to content

Commit d86b675

Browse files
committed
Refactor docs
1 parent 5ef6222 commit d86b675

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

readme.md

Lines changed: 12 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-transparent
@@ -66,6 +66,7 @@ import {transparent} from 'hast-util-transparent'
6666
transparent({
6767
type: 'element',
6868
tagName: 'div',
69+
properties: {},
6970
children: [{type: 'text', value: 'Alpha'}]
7071
}) // => false
7172

@@ -79,7 +80,7 @@ transparent({
7980

8081
## API
8182

82-
This package exports the identifier [`transparent`][transparent].
83+
This package exports the identifier [`transparent`][api-transparent].
8384
There is no default export.
8485

8586
### `transparent(value)`
@@ -106,10 +107,13 @@ It exports no additional types.
106107

107108
## Compatibility
108109

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

114118
## Security
115119

@@ -177,9 +181,9 @@ abide by its terms.
177181

178182
[downloads]: https://www.npmjs.com/package/hast-util-transparent
179183

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

182-
[size]: https://bundlephobia.com/result?p=hast-util-transparent
186+
[size]: https://bundlejs.com/?q=hast-util-transparent
183187

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

@@ -219,4 +223,4 @@ abide by its terms.
219223

220224
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
221225

222-
[transparent]: #transparentvalue
226+
[api-transparent]: #transparentvalue

0 commit comments

Comments
 (0)