Add improved docs

Author: wooorm

lib/index.js

@@ -16,6 +16,8 @@ import {convertElement} from 'hast-util-is-element'
  *   Thing to check (typically `Node`).
  * @returns
  *   Whether `value` is a script-supporting element.
+ *
+ *   The elements `script` and `template` are script-supporting.
  */
 // @ts-expect-error Sure, the assertion matches.
 export const scriptSupporting = convertElement(['script', 'template'])

readme.md

@@ -8,7 +8,7 @@
 [![Backers][backers-badge]][collective]
 [![Chat][chat-badge]][chat]
 
-[hast][] utility to check if a node is [*script-supporting*][spec].
+[hast][] utility to check if a node is a [*script-supporting* element][spec].
 
 ## Contents
 
@@ -17,7 +17,7 @@
 *   [Install](#install)
 *   [Use](#use)
 *   [API](#api)
-    *   [`scriptSupporting(node)`](#scriptsupportingnode)
+    *   [`scriptSupporting(value)`](#scriptsupportingvalue)
 *   [Types](#types)
 *   [Compatibility](#compatibility)
 *   [Security](#security)
@@ -38,7 +38,7 @@ looking for!
 ## Install
 
 This package is [ESM only][esm].
-In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with [npm][]:
+In Node.js (version 14.14+ and 16.0+), install with [npm][]:
 
 ```sh
 npm install hast-util-script-supporting
@@ -79,20 +79,22 @@ scriptSupporting({
 
 ## API
 
-This package exports the identifier `scriptSupporting`.
+This package exports the identifier [`scriptSupporting`][scriptsupporting].
 There is no default export.
 
-### `scriptSupporting(node)`
+### `scriptSupporting(value)`
 
-Check if the given value is a [*script-supporting*][spec] [*element*][element].
+Check if the given value is a [*script-supporting* element][spec].
 
 ###### Parameters
 
-*   `node` ([`Node`][node]) — node to check
+*   `value` (`unknown`) — thing to check (typically [`Node`][node])
 
 ###### Returns
 
-Whether the `value` is script-supporting (`boolean`).
+Whether `value` is a script-supporting element (`boolean`).
+
+The elements `script` and `template` are script-supporting.
 
 ## Types
 
@@ -103,7 +105,7 @@ It exports no additional types.
 
 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+, 16.0+, and 18.0+.
+As of now, that is Node.js 14.14+ and 16.0+.
 Our projects sometimes work with older versions, but this is not guaranteed.
 
 ## Security
@@ -206,12 +208,12 @@ abide by its terms.
 
 [coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
 
-[spec]: https://html.spec.whatwg.org/#script-supporting-elements
+[spec]: https://html.spec.whatwg.org/multipage/dom.html#script-supporting-elements
 
 [hast]: https://github.com/syntax-tree/hast
 
-[element]: https://github.com/syntax-tree/hast#element
-
 [node]: https://github.com/syntax-tree/hast#nodes
 
 [xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
+
+[scriptsupporting]: #scriptsupportingvalue