Skip to content

Commit d5a5f26

Browse files
committed
Refactor docs
1 parent 475ea66 commit d5a5f26

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

readme.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ the same but uses a heading to mark the start and end of sections.
4747
## Install
4848

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

5252
```sh
5353
npm install mdast-zone
@@ -82,9 +82,9 @@ Foo
8282
…and a module `example.js`:
8383

8484
```js
85-
import {read} from 'to-vfile'
86-
import {remark} from 'remark'
8785
import {zone} from 'mdast-zone'
86+
import {remark} from 'remark'
87+
import {read} from 'to-vfile'
8888

8989
const file = await remark()
9090
.use(myPluginThatReplacesFoo)
@@ -137,7 +137,7 @@ Search `tree` for a start and end comments matching `name` and change their
137137

138138
###### Returns
139139

140-
Nothing (`void`).
140+
Nothing (`undefined`).
141141

142142
### `Handler`
143143

@@ -183,10 +183,13 @@ It exports the additional types [`Handler`][api-handler] and
183183

184184
## Compatibility
185185

186-
Projects maintained by the unified collective are compatible with all maintained
186+
Projects maintained by the unified collective are compatible with maintained
187187
versions of Node.js.
188-
As of now, that is Node.js 14.14+ and 16.0+.
189-
Our projects sometimes work with older versions, but this is not guaranteed.
188+
189+
When we cut a new major release, we drop support for unmaintained versions of
190+
Node.
191+
This means we try to keep the current release line, `mdast-zone@^5`,
192+
compatible with Node.js 12.
190193

191194
## Security
192195

@@ -247,9 +250,9 @@ abide by its terms.
247250

248251
[downloads]: https://www.npmjs.com/package/mdast-zone
249252

250-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-zone.svg
253+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-zone
251254

252-
[size]: https://bundlephobia.com/result?p=mdast-zone
255+
[size]: https://bundlejs.com/?q=mdast-zone
253256

254257
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
255258

0 commit comments

Comments
 (0)