Refactor prose

Author: wooorm

package.json

@@ -38,12 +38,14 @@
     "eslint-plugin-import": "^2.0.0",
     "glob": "^7.0.0",
     "jest-cli": "^24.0.0",
+    "remark-cli": "^6.0.1",
+    "remark-preset-wooorm": "^5.0.0",
     "rollup": "^1.0.0",
     "rollup-plugin-babel": "^4.0.1"
   },
   "scripts": {
     "build": "rollup -c",
-    "lint": "eslint .",
+    "lint": "remark . -qfo && eslint .",
     "test": "jest",
     "test:dev": "jest --watchAll"
   },
@@ -60,5 +62,10 @@
         "statements": 100
       }
     }
+  },
+  "remarkConfig": {
+    "plugins": [
+      "preset-wooorm"
+    ]
   }
 }

readme.md

@@ -1,24 +1,34 @@
-# hast-util-from-dom [![Build Status][travis-badge]][travis]
+# hast-util-from-dom
 
-Transform a DOM tree to [HAST][]
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Sponsors][sponsors-badge]][collective]
+[![Backers][backers-badge]][collective]
+[![Chat][chat-badge]][chat]
 
-## Installation
+[**hast**][hast] utility to transform from a DOM tree.
+
+## Install
 
 [yarn][]:
 
-```bash
+```sh
 yarn add hast-util-from-dom
 ```
 
 [npm][]:
 
-```bash
+```sh
 npm install hast-util-from-dom
 ```
 
 ## Usage
 
-This utility is similar to [`hast-util-from-parse5`][hast-util-from-parse5], but is intended for browser use and therefore relies on the native DOM API instead of an external parsing library.
+This utility is similar to [`hast-util-from-parse5`][hast-util-from-parse5], but
+is intended for browser use and therefore relies on the native DOM API instead
+of an external parsing library.
 
 Say we have the following file, `example.html`:
 
@@ -32,7 +42,7 @@ Suppose `example.js` is a bundled version of something like this:
 import inspect from 'unist-util-inspect';
 import fromDOM from 'hast-util-from-dom';
 
-const hast = fromDOM(document.documentElement.parentNode);
+const hast = fromDOM(document);
 
 console.log(inspect.noColor(hast));
 ```
@@ -57,27 +67,53 @@ root[2]
 
 ### `fromDOM(node)`
 
-Transform a DOM `Node` to a [HAST Node][node].
+Transform a DOM tree to a [**hast**][hast] [*tree*][tree].
 
-This works in a similar way to the `parse5` version except that it works directly from the DOM rather than a string of HTML. Consequently, it does not maintain location infomation.
+This works in a similar way to the [`parse5`][hast-util-from-parse5] version
+except that it works directly from the DOM rather than a string of HTML.
+Consequently, it does not maintain [positional info][positional-information].
 
 ## Contribute
 
-See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get
+See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
 started.
+See [`support.md`][support] for ways to get help.
 
-This organisation has a [Code of Conduct][coc].  By interacting with this
-repository, organisation, or community you agree to abide by its terms.
+This project has a [Code of Conduct][coc].
+By interacting with this repository, organisation, or community you agree to
+abide by its terms.
 
 ## License
 
 [ISC][license] © [Keith McKnight][author]
 
 <!-- Definitions -->
 
-[travis-badge]: https://img.shields.io/travis/syntax-tree/hast-util-from-dom.svg
+[build-badge]: https://img.shields.io/travis/syntax-tree/hast-util-from-dom.svg
+
+[build]: https://travis-ci.org/syntax-tree/hast-util-from-dom
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-from-dom.svg
+
+[coverage]: https://codecov.io/github/syntax-tree/hast-util-from-dom
+
+[downloads-badge]: https://img.shields.io/npm/dm/hast-util-from-dom.svg
+
+[downloads]: https://www.npmjs.com/package/hast-util-from-dom
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-from-dom.svg
+
+[size]: https://bundlephobia.com/result?p=hast-util-from-dom
+
+[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
 
-[travis]: https://travis-ci.org/syntax-tree/hast-util-from-dom
+[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+
+[collective]: https://opencollective.com/unified
+
+[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
+
+[chat]: https://spectrum.chat/unified/syntax-tree
 
 [yarn]: https://yarnpkg.com/lang/en/docs/install
 
@@ -87,12 +123,16 @@ repository, organisation, or community you agree to abide by its terms.
 
 [author]: https://keith.mcknig.ht
 
-[hast]: https://github.com/syntax-tree/hast
+[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
 
-[hast-util-from-parse5]: https://github.com/syntax-tree/hast-util-from-parse5
+[support]: https://github.com/syntax-tree/.github/blob/master/support.md
 
-[node]: https://github.com/syntax-tree/hast#ast
+[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
 
-[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md
+[tree]: https://github.com/syntax-tree/unist#tree
 
-[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md
+[positional-information]: https://github.com/syntax-tree/unist#positional-information
+
+[hast]: https://github.com/syntax-tree/hast
+
+[hast-util-from-parse5]: https://github.com/syntax-tree/hast-util-from-parse5