Skip to content

Commit 6b3e2d6

Browse files
committed
Refactor docs
1 parent 513ebeb commit 6b3e2d6

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
@@ -43,7 +43,7 @@ does the same but for [remark][].
4343
## Install
4444

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

4848
```sh
4949
npm install mdast-squeeze-paragraphs
@@ -66,8 +66,8 @@ In browsers with [`esm.sh`][esmsh]:
6666
## Use
6767

6868
```js
69-
import {u} from 'unist-builder'
7069
import {squeezeParagraphs} from 'mdast-squeeze-paragraphs'
70+
import {u} from 'unist-builder'
7171

7272
const tree = u('root', [
7373
u('paragraph', []),
@@ -115,10 +115,13 @@ It exports no additional types..
115115

116116
## Compatibility
117117

118-
Projects maintained by the unified collective are compatible with all maintained
118+
Projects maintained by the unified collective are compatible with maintained
119119
versions of Node.js.
120-
As of now, that is Node.js 14.14+ and 16.0+.
121-
Our projects sometimes work with older versions, but this is not guaranteed.
120+
121+
When we cut a new major release, we drop support for unmaintained versions of
122+
Node.
123+
This means we try to keep the current release line,
124+
`mdast-squeeze-paragraphs@^5`, compatible with Node.js 12.
122125

123126
## Security
124127

@@ -160,9 +163,9 @@ abide by its terms.
160163

161164
[downloads]: https://www.npmjs.com/package/mdast-squeeze-paragraphs
162165

163-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-squeeze-paragraphs.svg
166+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-squeeze-paragraphs
164167

165-
[size]: https://bundlephobia.com/result?p=mdast-squeeze-paragraphs
168+
[size]: https://bundlejs.com/?q=mdast-squeeze-paragraphs
166169

167170
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
168171

0 commit comments

Comments
 (0)