Skip to content

Commit d1880dd

Browse files
committed
Refactor docs
1 parent 5573ee5 commit d1880dd

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

readme.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You can instead use [`unist-builder`][u] when creating any unist nodes and
4848
## Install
4949

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

5353
```sh
5454
npm install xastscript
@@ -191,7 +191,7 @@ Yields:
191191

192192
## API
193193

194-
This package exports the identifier [`x`][x].
194+
This package exports the identifier [`x`][api-x].
195195
There is no default export.
196196

197197
The export map supports the automatic JSX runtime.
@@ -220,15 +220,15 @@ When nullish, a [`Root`][root] is built instead.
220220

221221
###### `attributes`
222222

223-
Attributes of the element ([`Attributes`][attributes], optional).
223+
Attributes of the element ([`Attributes`][api-attributes], optional).
224224

225225
###### `children`
226226

227-
Children of the node ([`Child`][child] or `Array<Child>`, optional).
227+
Children of the node ([`Array<Child>`][api-child] or `Child`, optional).
228228

229229
##### Returns
230230

231-
Created tree ([`Result`][result]).
231+
Created tree ([`Result`][api-result]).
232232

233233
[`Element`][element] when a `name` is passed, otherwise [`Root`][root].
234234

@@ -294,7 +294,7 @@ You should use the automatic JSX runtime set to `xastscript`.
294294
The Use example above (omitting the second) can then be written like so:
295295
296296
```jsx
297-
/** @jsxImportSource x */
297+
/** @jsxImportSource xastscript */
298298

299299
import {u} from 'unist-builder'
300300

@@ -321,15 +321,18 @@ console.log(
321321
## Types
322322

323323
This package is fully typed with [TypeScript][].
324-
It exports the additional types [`Attributes`][attributes], [`Child`][child],
325-
and [`Result`][result].
324+
It exports the additional types [`Attributes`][api-attributes],
325+
[`Child`][api-child], and [`Result`][api-result].
326326

327327
## Compatibility
328328

329-
Projects maintained by the unified collective are compatible with all maintained
329+
Projects maintained by the unified collective are compatible with maintained
330330
versions of Node.js.
331-
As of now, that is Node.js 14.14+ and 16.0+.
332-
Our projects sometimes work with older versions, but this is not guaranteed.
331+
332+
When we cut a new major release, we drop support for unmaintained versions of
333+
Node.
334+
This means we try to keep the current release line, `xastscript@^3`, compatible
335+
with Node.js 12.
333336

334337
## Security
335338

@@ -376,9 +379,9 @@ abide by its terms.
376379

377380
[downloads]: https://www.npmjs.com/package/xastscript
378381

379-
[size-badge]: https://img.shields.io/bundlephobia/minzip/xastscript.svg
382+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=xastscript
380383

381-
[size]: https://bundlephobia.com/result?p=xastscript
384+
[size]: https://bundlejs.com/?q=xastscript
382385

383386
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
384387

@@ -422,10 +425,10 @@ abide by its terms.
422425

423426
[h]: https://github.com/syntax-tree/hastscript
424427

425-
[x]: #xname-attributes-children
428+
[api-x]: #xname-attributes-children
426429

427-
[attributes]: #attributes-1
430+
[api-attributes]: #attributes-1
428431

429-
[child]: #child
432+
[api-child]: #child
430433

431-
[result]: #result
434+
[api-result]: #result

0 commit comments

Comments
 (0)