Skip to content

Commit 75e73c7

Browse files
committed
Refactor docs
1 parent 8ca2ec0 commit 75e73c7

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

readme.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Similar packages, [`hast-util-to-string`][hast-util-to-string] and
4444
## Install
4545

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

4949
```sh
5050
npm install mdast-util-to-string
@@ -67,7 +67,6 @@ In browsers with [`esm.sh`][esmsh]:
6767
## Use
6868

6969
```js
70-
import {unified} from 'unified'
7170
import {fromMarkdown} from 'mdast-util-from-markdown'
7271
import {toString} from 'mdast-util-to-string'
7372

@@ -78,7 +77,7 @@ console.log(toString(tree)) // => 'Some emphasis, importance, and code.'
7877

7978
## API
8079

81-
This package exports the identifier [`toString`][api-tostring].
80+
This package exports the identifier [`toString`][api-to-string].
8281
There is no default export.
8382

8483
### `toString(value[, options])`
@@ -117,10 +116,13 @@ It exports the additional type [`Options`][api-options].
117116

118117
## Compatibility
119118

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

125127
## Security
126128

@@ -163,9 +165,9 @@ abide by its terms.
163165

164166
[downloads]: https://www.npmjs.com/package/mdast-util-to-string
165167

166-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-to-string.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-to-string
167169

168-
[size]: https://bundlephobia.com/result?p=mdast-util-to-string
170+
[size]: https://bundlejs.com/?q=mdast-util-to-string
169171

170172
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
171173

@@ -211,6 +213,6 @@ abide by its terms.
211213

212214
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
213215

214-
[api-tostring]: #tostringvalue-options
216+
[api-to-string]: #tostringvalue-options
215217

216218
[api-options]: #options

0 commit comments

Comments
 (0)