Refactor docs

Author: wooorm

readme.md

@@ -1,14 +1,14 @@
-# nlcst-is-literal [![Build Status](https://img.shields.io/travis/wooorm/nlcst-is-literal.svg)](https://travis-ci.org/wooorm/nlcst-is-literal) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/nlcst-is-literal.svg)](https://codecov.io/github/wooorm/nlcst-is-literal)
+# nlcst-is-literal [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
 
-Check whether an NLCST node is meant literally.  Useful if a tool wants to
+Check if an NLCST node is meant literally.  Useful if a tool wants to
 exclude these values possibly void of meaning.
 
 As an example, a spell-checker could exclude these literal words, thus not
 warning about “monsieur”.
 
 ## Installation
 
-[npm](https://docs.npmjs.com/cli/install):
+[npm][]:
 
 ```bash
 npm install nlcst-is-literal
@@ -20,23 +20,27 @@ npm install nlcst-is-literal
 var retext = require('retext');
 var visit = require('unist-util-visit');
 var toString = require('nlcst-to-string');
-var isLiteral = require('.');
-
-retext().use(function () {
-  return function (cst) {
-    visit(cst, 'WordNode', function (node, index, parent) {
-      if (isLiteral(parent, index)) {
-        console.log(toString(node));
-      }
-    });
-  }
-}).process([
+var literal = require('nlcst-is-literal');
+
+retext().use(plugin).process([
   'The word “foo” is meant as a literal.',
   'The word «bar» is meant as a literal.',
   'The word (baz) is meant as a literal.',
   'The word, qux, is meant as a literal.',
   'The word — quux — is meant as a literal.'
 ].join('\n\n'));
+
+function plugin() {
+  return transformer;
+  function transformer(tree) {
+    visit(tree, 'WordNode', visitor);
+  }
+  function visitor(node, index, parent) {
+    if (literal(parent, index)) {
+      console.log(toString(node));
+    }
+  }
+}
 ```
 
 Yields:
@@ -51,7 +55,7 @@ quux
 
 ## API
 
-### isLiteral(parent, index)
+### `isLiteral(parent, index)`
 
 Check if the node in `parent` at `position` is enclosed
 by matching delimiters.
@@ -64,22 +68,22 @@ For example, in:
 
 ...`foo` is literal.
 
-###### Parameters
+## License
+
+[MIT][license] © [Titus Wormer][author]
 
-*   `node` ([`NLCSTParentNode`](https://github.com/wooorm/nlcst#parent))
-    — Parent to search.
+<!-- Definitions -->
 
-*   `nodes` (`Array.<NLCSTNode>`) — Position of node to check.
+[travis-badge]: https://img.shields.io/travis/wooorm/nlcst-is-literal.svg
 
-###### Returns
+[travis]: https://travis-ci.org/wooorm/nlcst-is-literal
 
-`boolean` — Whether the node is literal.
+[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/nlcst-is-literal.svg
 
-**Throws**
+[codecov]: https://codecov.io/github/wooorm/nlcst-is-literal
 
-*   `Error` — When no parent node is given;
-*   `Error` — When no index is given.
+[npm]: https://docs.npmjs.com/cli/install
 
-## License
+[license]: LICENSE
 
-[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
+[author]: http://wooorm.com