Add improved docs

Author: wooorm

lib/index.js

@@ -25,12 +25,12 @@ const search = /\r?\n|\r/g
 /**
  * Parse a string of XML to a xast tree.
  *
- * @param {string | Uint8Array} doc
+ * @param {string | Uint8Array} value
  *   Serialized XML.
  * @returns {Root}
  *   xast root.
  */
-export function fromXml(doc) {
+export function fromXml(value) {
   // @ts-expect-error `strictEntities` is most definitely fine.
   const parser = new Parser(true, {position: true, strictEntities: true})
   /** @type {[Root, ...Array<Node>]} */
@@ -50,7 +50,7 @@ export function fromXml(doc) {
   parser.onerror = onerror
 
   // @ts-expect-error Buffers are most definitely fine.
-  parser.write(doc).close()
+  parser.write(value).close()
 
   return stack[0]
 

readme.md

@@ -44,7 +44,7 @@ It turns xast into XML.
 ## 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 xast-util-from-xml
@@ -129,22 +129,21 @@ console.log(tree)
 
 ## API
 
-This package exports the identifier `fromXml`.
+This package exports the identifier [`fromXml`][fromxml].
 There is no default export.
 
 ### `fromXml(value)`
 
-Turn XML into a syntax tree.
+Parse a string of XML to a xast tree.
 
 ##### Parameters
 
-###### `value`
-
-Value to parse (`string` or `Buffer` in UTF-8).
+*   `value` (`string` or `Buffer` in UTF-8).
+    — serialized XML
 
 ##### Returns
 
-[`Root`][root].
+xast root ([`Root`][root]).
 
 ## Types
 
@@ -155,7 +154,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
@@ -240,3 +239,5 @@ abide by its terms.
 [sax]: https://github.com/isaacs/sax-js
 
 [xast-util-to-xml]: https://github.com/syntax-tree/xast-util-to-xml
+
+[fromxml]: #fromxmlvalue