Add improved docs

Author: wooorm

index.js

@@ -410,7 +410,7 @@ function table(node) {
 
   if (node.align != null) {
     nodeAssert(Array.isArray(node.align), '`align` must be `array`')
-    /** @type {Array.<unknown>} */
+    /** @type {Array<unknown>} */
     const align = node.align // type-coverage:ignore-line
 
     while (++index < align.length) {

readme.md

@@ -8,19 +8,58 @@
 [![Backers][backers-badge]][collective]
 [![Chat][chat-badge]][chat]
 
-[**mdast**][mdast] utility to assert trees.
+[mdast][] utility to assert trees.
 
-## Install
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`assert(node)`](#assertnode)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This package is a tiny utility that helps you deal with nodes.
+
+## When should I use this?
 
-This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
-Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
+This utility is typically useful when you expect certain nodes in your APIs
+and want to make sure they’re valid and as expected.
 
-[npm][]:
+A different utility, [`unist-util-assert`][unist-util-assert], does the same but
+for any [unist][] node.
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
 ```sh
 npm install mdast-util-assert
 ```
 
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import {assert} from 'https://esm.sh/mdast-util-assert@4'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import {assert} from 'https://esm.sh/mdast-util-assert@4?bundle'
+</script>
+```
+
 ## Use
 
 ```js
@@ -40,8 +79,8 @@ assert({type: 'paragraph', value: 'foo'})
 
 ## API
 
-This package exports the following identifiers: `assert`, `parent`, `literal`,
-`_void`, `wrap`.
+This package exports the identifiers `assert`, `parent`, `literal`, `_void`,
+and `wrap`.
 There is no default export.
 
 ### `assert(node)`
@@ -50,7 +89,27 @@ Assert that [`tree`][tree] is a valid [mdast][] [node][].
 If `tree` is a [parent][], all [child][]ren will be asserted as well.
 
 The `parent`, `literal`, `_void`, and `wrap` methods from
-[`unist-util-assert`][unist-util-assert] are also included.
+[`unist-util-assert`][unist-util-assert] are also exported.
+
+###### Throws
+
+When `node`, or one of its children, is not a valid mdast node.
+
+###### Returns
+
+Nothing.
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It does not export additional types.
+
+## Compatibility
+
+Projects maintained by the unified collective are compatible with all maintained
+versions of Node.js.
+As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
+Our projects sometimes work with older versions, but this is not guaranteed.
 
 ## Security
 
@@ -60,16 +119,16 @@ openings for [cross-site scripting (XSS)][xss] attacks.
 ## Related
 
 *   [`unist-util-assert`][unist-util-assert]
-    — check [unist](https://github.com/syntax-tree/unist) nodes
+    — check unist nodes
 *   [`hast-util-assert`](https://github.com/syntax-tree/hast-util-assert)
-    — check [hast](https://github.com/syntax-tree/hast) nodes
+    — check hast nodes
 *   [`nlcst-test`](https://github.com/syntax-tree/nlcst-test)
-    — check [nlcst](https://github.com/syntax-tree/nlcst) nodes
+    — check nlcst nodes
 
 ## Contribute
 
-See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
-started.
+See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
+ways to get started.
 See [`support.md`][support] for ways to get help.
 
 This project has a [code of conduct][coc].
@@ -110,28 +169,38 @@ abide by its terms.
 
 [npm]: https://docs.npmjs.com/cli/install
 
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[typescript]: https://www.typescriptlang.org
+
 [license]: license
 
 [author]: https://wooorm.com
 
-[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
+[health]: https://github.com/syntax-tree/.github
 
-[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
+[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
 
-[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
+[support]: https://github.com/syntax-tree/.github/blob/main/support.md
 
-[mdast]: https://github.com/syntax-tree/mdast
+[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
 
-[unist-util-assert]: https://github.com/syntax-tree/unist-util-assert
+[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
+
+[unist]: https://github.com/syntax-tree/unist
 
 [tree]: https://github.com/syntax-tree/unist#tree
 
 [child]: https://github.com/syntax-tree/unist#child
 
+[unist-util-assert]: https://github.com/syntax-tree/unist-util-assert
+
+[mdast]: https://github.com/syntax-tree/mdast
+
 [node]: https://github.com/syntax-tree/mdast#nodes
 
 [parent]: https://github.com/syntax-tree/mdast#parent
 
-[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
-
 [hast]: https://github.com/syntax-tree/hast