Add improved docs

Author: wooorm

index.js

@@ -6,6 +6,8 @@
 import {remove} from 'unist-util-remove'
 
 /**
+ * Remove empty paragraphs in `tree`.
+ *
  * @template {Node} Tree
  * @param {Tree} tree
  * @returns {Tree extends Paragraph ? Tree | null : Tree}

readme.md

@@ -8,20 +8,59 @@
 [![Backers][backers-badge]][collective]
 [![Chat][chat-badge]][chat]
 
-[**mdast**][mdast] utility to remove empty paragraphs from a tree.
-
+[mdast][] utility to remove empty paragraphs.
+
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`squeezeParagraphs(tree)`](#squeezeparagraphstree)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This package is a utility that removes empty paragraphs, left over from other
+operations, from the tree.
 Paragraphs are considered empty if they do not contain non-whitespace
 characters.
 
-## Install
+## 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.
+Probably never!
+You should try to clean your trees yourself.
 
-[npm][]:
+A plugin, [`remark-squeeze-paragraphs`][remark-squeeze-paragraphs], exists that
+does the same but for [remark][].
+
+## 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-squeeze-paragraphs
+npm install mdast-util-squeeze-paragraphs
+```
+
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import {squeezeParagraphs} from 'https://esm.sh/mdast-util-squeeze-paragraphs@5'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import {squeezeParagraphs} from 'https://esm.sh/mdast-util-squeeze-paragraphs@5?bundle'
+</script>
 ```
 
 ## Use
@@ -52,30 +91,45 @@ Yields:
 
 ## API
 
-This package exports the following identifiers: `squeezeParagraphs`.
+This package exports the identifier `squeezeParagraphs`.
 There is no default export.
 
 ### `squeezeParagraphs(tree)`
 
-Modifies [tree][] in-place.
-Returns `tree`.
+Remove empty paragraphs in `tree` ([`Node`][node]).
+
+###### Returns
+
+The given `tree` ([`Node`][node]).
+
+## Types
+
+This package is fully typed with [TypeScript][].
+There are no additional types exported.
+
+## 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
 
-Use of `mdast-squeeze-paragraphs` does not involve [**hast**][hast] or user
-content so there are no openings for [cross-site scripting (XSS)][xss] attacks.
+Use of `mdast-squeeze-paragraphs` does not involve **[hast][]** or user content
+so there are no openings for [cross-site scripting (XSS)][xss] attacks.
 
 ## Related
 
-*   [`remark-squeeze-paragraphs`][squeeze-paragraphs]
-    — [**remark**][remark] plugin wrapper
+*   [`remark-squeeze-paragraphs`][remark-squeeze-paragraphs]
+    — remark plugin
 *   [`mdast-util-compact`](https://github.com/syntax-tree/mdast-util-compact)
     — make a tree compact
 
 ## 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].
@@ -116,22 +170,30 @@ abide by its terms.
 
 [npm]: https://docs.npmjs.com/cli/install
 
-[license]: license
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
-[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
+[esmsh]: https://esm.sh
 
-[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
+[typescript]: https://www.typescriptlang.org
 
-[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
+[license]: license
 
-[tree]: https://github.com/syntax-tree/unist#tree
+[health]: https://github.com/syntax-tree/.github
 
-[mdast]: https://github.com/syntax-tree/mdast
+[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
 
-[remark]: https://github.com/remarkjs/remark
+[support]: https://github.com/syntax-tree/.github/blob/main/support.md
 
-[squeeze-paragraphs]: https://github.com/remarkjs/remark-squeeze-paragraphs
+[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
 
 [xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
 
 [hast]: https://github.com/syntax-tree/hast
+
+[mdast]: https://github.com/syntax-tree/mdast
+
+[node]: https://github.com/syntax-tree/mdast#node
+
+[remark]: https://github.com/remarkjs/remark
+
+[remark-squeeze-paragraphs]: https://github.com/remarkjs/remark-squeeze-paragraphs