Skip to content

Commit fba716f

Browse files
committed
Refactor docs
1 parent ad6a164 commit fba716f

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

readme.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ It’s small and protects against prototype pollution.
3939
## Install
4040

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

4444
```sh
4545
npm install mdast-util-definitions
@@ -62,8 +62,8 @@ In browsers with [`esm.sh`][esmsh]:
6262
## Use
6363

6464
```js
65-
import {fromMarkdown} from 'mdast-util-from-markdown'
6665
import {definitions} from 'mdast-util-definitions'
66+
import {fromMarkdown} from 'mdast-util-from-markdown'
6767

6868
const tree = fromMarkdown('[example]: https://example.com "Example"')
6969

@@ -118,10 +118,13 @@ It exports the additional type [`GetDefinition`][api-getdefinition].
118118

119119
## Compatibility
120120

121-
Projects maintained by the unified collective are compatible with all maintained
121+
Projects maintained by the unified collective are compatible with maintained
122122
versions of Node.js.
123-
As of now, that is Node.js 14.14+ and 16.0+.
124-
Our projects sometimes work with older versions, but this is not guaranteed.
123+
124+
When we cut a new major release, we drop support for unmaintained versions of
125+
Node.
126+
This means we try to keep the current release line,
127+
`mdast-util-definitions@^6`, compatible with Node.js 12.
125128

126129
## Security
127130

@@ -162,9 +165,9 @@ abide by its terms.
162165

163166
[downloads]: https://www.npmjs.com/package/mdast-util-definitions
164167

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

167-
[size]: https://bundlephobia.com/result?p=mdast-util-definitions
170+
[size]: https://bundlejs.com/?q=mdast-util-definitions
168171

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

0 commit comments

Comments
 (0)