Skip to content

Commit 5fd02b9

Browse files
committed
Refactor docs
1 parent d81ed61 commit 5fd02b9

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

readme.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ for any [unist][] node.
4545
## Install
4646

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

5050
```sh
5151
npm install mdast-util-assert
@@ -111,7 +111,7 @@ Nothing.
111111
###### Throws
112112

113113
When `tree` (or its descendants) is not an mdast node
114-
([`AssertionError`][assertionerror]).
114+
([`AssertionError`][api-assertion-error]).
115115

116116
### `parent(tree[, parent])`
117117

@@ -135,7 +135,7 @@ Nothing.
135135
###### Throws
136136

137137
When `tree` is not a parent or its descendants are not nodes
138-
([`AssertionError`][assertionerror])
138+
([`AssertionError`][api-assertion-error])
139139

140140
### `literal(node[, parent])`
141141

@@ -156,7 +156,7 @@ Nothing.
156156

157157
###### Throws
158158

159-
When `node` is not an mdast literal ([`AssertionError`][assertionerror]).
159+
When `node` is not an mdast literal ([`AssertionError`][api-assertion-error]).
160160

161161
### `_void(node[, parent])`
162162

@@ -173,14 +173,17 @@ Re-exported from [`unist-util-assert`][unist-util-assert-assertionerror].
173173
## Types
174174

175175
This package is fully typed with [TypeScript][].
176-
It exports the additional type [`AssertionError`][assertionerror].
176+
It exports the additional type [`AssertionError`][api-assertion-error].
177177

178178
## Compatibility
179179

180-
Projects maintained by the unified collective are compatible with all maintained
180+
Projects maintained by the unified collective are compatible with maintained
181181
versions of Node.js.
182-
As of now, that is Node.js 14.14+ and 16.0+.
183-
Our projects sometimes work with older versions, but this is not guaranteed.
182+
183+
When we cut a new major release, we drop support for unmaintained versions of
184+
Node.
185+
This means we try to keep the current release line, `mdast-util-assert@^4`,
186+
compatible with Node.js 12.
184187

185188
## Security
186189

@@ -224,9 +227,9 @@ abide by its terms.
224227

225228
[downloads]: https://www.npmjs.com/package/mdast-util-assert
226229

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

229-
[size]: https://bundlephobia.com/result?p=mdast-util-assert
232+
[size]: https://bundlejs.com/?q=mdast-util-assert
230233

231234
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
232235

@@ -284,7 +287,7 @@ abide by its terms.
284287

285288
[api-wrap]: #wrapfn
286289

287-
[assertionerror]: #assertionerror
290+
[api-assertion-error]: #assertionerror
288291

289292
[unist-util-assert-void]: https://github.com/syntax-tree/unist-util-assert#_voidnode-parent
290293

0 commit comments

Comments
 (0)