Skip to content

Commit 3216756

Browse files
committed
Refactor docs
1 parent 56868aa commit 3216756

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

readme.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ about “monsieur”.
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 nlcst-is-literal
@@ -106,7 +106,7 @@ quux
106106

107107
## API
108108

109-
This package exports the identifier [`isLiteral`][isliteral].
109+
This package exports the identifier [`isLiteral`][api-is-literal].
110110
There is no default export.
111111

112112
### `isLiteral(parent, index|child)`
@@ -139,10 +139,13 @@ It exports no additional types.
139139

140140
## Compatibility
141141

142-
Projects maintained by the unified collective are compatible with all maintained
142+
Projects maintained by the unified collective are compatible with maintained
143143
versions of Node.js.
144-
As of now, that is Node.js 14.14+ and 16.0+.
145-
Our projects sometimes work with older versions, but this is not guaranteed.
144+
145+
When we cut a new major release, we drop support for unmaintained versions of
146+
Node.
147+
This means we try to keep the current release line, `nlcst-is-literal@^2`,
148+
compatible with Node.js 12.
146149

147150
## Related
148151

@@ -179,9 +182,9 @@ abide by its terms.
179182

180183
[downloads]: https://www.npmjs.com/package/nlcst-is-literal
181184

182-
[size-badge]: https://img.shields.io/bundlephobia/minzip/nlcst-is-literal.svg
185+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=nlcst-is-literal
183186

184-
[size]: https://bundlephobia.com/result?p=nlcst-is-literal
187+
[size]: https://bundlejs.com/?q=nlcst-is-literal
185188

186189
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
187190

@@ -217,4 +220,4 @@ abide by its terms.
217220

218221
[node]: https://github.com/syntax-tree/nlcst#nodes
219222

220-
[isliteral]: #isliteralparent-indexchild
223+
[api-is-literal]: #isliteralparent-indexchild

0 commit comments

Comments
 (0)