Skip to content

Commit 35e0420

Browse files
committed
Refactor docs
1 parent e4fe868 commit 35e0420

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
@@ -44,7 +44,7 @@ with a tool such as recast or Babel.
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 estree-util-attach-comments
@@ -86,7 +86,7 @@ const code = String(await fs.readFile('x.js'))
8686
const comments = []
8787
const tree = parse(code, {
8888
sourceType: 'module',
89-
ecmaVersion: 2020,
89+
ecmaVersion: 'latest',
9090
onComment: comments
9191
})
9292

@@ -120,7 +120,7 @@ a(
120120
121121
## API
122122

123-
This package exports the identifier [`attachComments`][attachcomments].
123+
This package exports the identifier [`attachComments`][api-attach-comments].
124124
There is no default export.
125125

126126
### `attachComments(tree, comments)`
@@ -163,10 +163,13 @@ It exports no additional types.
163163

164164
## Compatibility
165165

166-
Projects maintained by the unified collective are compatible with all maintained
166+
Projects maintained by the unified collective are compatible with maintained
167167
versions of Node.js.
168-
As of now, that is Node.js 14.14+ and 16.0+.
169-
Our projects sometimes work with older versions, but this is not guaranteed.
168+
169+
When we cut a new major release, we drop support for unmaintained versions of
170+
Node.
171+
This means we try to keep the current release line,
172+
`estree-util-attach-comments@^2`, compatible with Node.js 12.
170173

171174
## Contribute
172175

@@ -196,9 +199,9 @@ abide by its terms.
196199

197200
[downloads]: https://www.npmjs.com/package/estree-util-attach-comments
198201

199-
[size-badge]: https://img.shields.io/bundlephobia/minzip/estree-util-attach-comments.svg
202+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=estree-util-attach-comments
200203

201-
[size]: https://bundlephobia.com/result?p=estree-util-attach-comments
204+
[size]: https://bundlejs.com/?q=estree-util-attach-comments
202205

203206
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
204207

@@ -236,4 +239,4 @@ abide by its terms.
236239

237240
[program]: https://github.com/estree/estree/blob/master/es5.md#programs
238241

239-
[attachcomments]: #attachcommentstree-comments
242+
[api-attach-comments]: #attachcommentstree-comments

0 commit comments

Comments
 (0)