Update readme.md

Author: wooorm

example.js

@@ -1,34 +1,35 @@
+// Dependencies:
 var heading = require('./index.js');
 var remark = require('remark');
 
+// Plug-in:
+function plugin() {
+    return function (node) {
+        heading(node, 'foo', function (start, nodes, end) {
+            return [
+                start,
+                {
+                    'type': 'paragraph',
+                    'children': [{
+                        'type': 'text',
+                        'value': 'Qux.'
+                    }]
+                },
+                end
+            ];
+        });
+    }
+}
+
 // Process a document.
-var doc = remark()
-    .use(function () {
-        return function (node) {
-            heading(node, 'foo', function (start, nodes, end) {
-                return [
-                    start,
-                    {
-                        'type': 'paragraph',
-                        'children': [
-                            {
-                                'type': 'text',
-                                'value': 'Qux.'
-                            }
-                        ]
-                    },
-                    end
-                ];
-            });
-        }
-    }).process([
-        '# Foo',
-        '',
-        'Bar.',
-        '',
-        '# Baz',
-        ''
-    ].join('\n'));
+var file = remark().use(plugin).process([
+    '# Foo',
+    '',
+    'Bar.',
+    '',
+    '# Baz',
+    ''
+].join('\n'));
 
 // Yields:
-console.log('markdown', doc);
+console.log('markdown', String(file));

readme.md

@@ -1,131 +1,134 @@
-# mdast-util-heading-range [![Build Status][travis-badge]][travis] [![Coverage Status][coverage-badge]][coverage]
+# mdast-util-heading-range [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
 
-Markdown heading as ranges in [**mdast**][mdast].
+<!--lint disable list-item-spacing heading-increment no-duplicate-headings-->
+
+Markdown heading as ranges in [**MDAST**][mdast].
 
 ## Installation
 
-[npm][npm-install]:
+[npm][]:
 
 ```bash
 npm install mdast-util-heading-range
 ```
 
-**mdast-util-heading-range** is also as an AMD, CommonJS, and globals
-module, [uncompressed and compressed][releases].
+**mdast-util-heading-range** is also available as an AMD, CommonJS, and
+globals module, [uncompressed and compressed][releases].
 
 ## Usage
 
+Dependencies:
+
 ```javascript
 var heading = require('mdast-util-heading-range');
 var remark = require('remark');
 ```
 
-Process a document.
+Plug-in:
 
 ```javascript
-var doc = remark()
-    .use(function () {
-        return function (node) {
-            heading(node, 'foo', function (start, nodes, end) {
-                return [
-                    start,
-                    {
-                        'type': 'paragraph',
-                        'children': [
-                            {
-                                'type': 'text',
-                                'value': 'Qux.'
-                            }
-                        ]
-                    },
-                    end
-                ];
-            });
-        }
-    }).process([
-        '# Foo',
-        '',
-        'Bar.',
-        '',
-        '# Baz',
-        ''
-    ].join('\n'));
+function plugin() {
+    return function (node) {
+        heading(node, 'foo', function (start, nodes, end) {
+            return [
+                start,
+                {
+                    'type': 'paragraph',
+                    'children': [{
+                        'type': 'text',
+                        'value': 'Qux.'
+                    }]
+                },
+                end
+            ];
+        });
+    }
+}
 ```
 
-Yields:
+Process a document.
 
 ```javascript
-console.log('markdown', doc);
+var file = remark().use(plugin).process([
+    '# Foo',
+    '',
+    'Bar.',
+    '',
+    '# Baz',
+    ''
+].join('\n'));
 ```
 
-## API
+Yields:
 
-### `heading(node, test, onrun)`
+```markdown
+# Foo
 
-Transform part of a document without affecting other parts, by changing a
-section: a heading which passes `test`, until the next heading of the same
-or lower depth, or the end of the document.
+Qux.
 
-**Parameters**
+# Baz
+```
 
-*   `node` ([`Node`][mdast-node]) — Node to search;
+## API
 
-*   `test` (`string`, `RegExp`, `function(string, Node): boolean`)
-    — Heading to look for:
+### `heading(node, test, onrun)`
 
-    *   When `string`, wrapped in
-        `new RegExp('^(' + value + ')$', 'i')`;
+Transform part of a document without affecting other parts, by changing
+a section: a heading which passes `test`, until the next heading of the
+same or lower depth, or the end of the document.
 
-    *   Then, when `RegExp`, wrapped in
-        `function (value) {expression.test(value)}`.
+###### Parameters
 
-*   [`onrun`](#function-onrunstart-nodes-end-scope)
-    (`Array.<Node>? = function (start, nodes, end)`)
-    — Callback invoked when a range is found.
+*   `node` ([`Node`][node]) — Node to search;
+*   `test` (`string`, `RegExp`, `function(string, Node): boolean`)
+    — Heading to look for.  When `string`, wrapped in
+    `new RegExp('^(' + value + ')$', 'i')`;  when `RegExp`, wrapped
+    in `function (value) {expression.test(value)}`.
+*   `onrun` ([`Function`][onrun]).
 
 #### `function onrun(start, nodes, end?, scope)`
 
-**Parameters**
+Callback invoked when a range is found.
 
-*   `start` (`Heading`) — Start of range;
+###### Parameters
 
+*   `start` (`Heading`) — Start of range;
 *   `nodes` (`Array.<Node>`) — Nodes between `start` and `end`;
-
 *   `end` (`Heading?`) — End of range, if any.
-
 *   `scope` (`Object`):
 
     *   `parent` (`Node`) — Parent of the range;
     *   `start` (`number`) — Index of `start` in `parent`;
     *   `end` (`number?`) — Index of `end` in `parent`.
 
-**Returns**
-
-`Array.<Node>?` — Zero or more nodes to replace the range (including
-`start`, and `end`) with.
-
 ## License
 
-[MIT][license] © [Titus Wormer][home]
+[MIT][license] © [Titus Wormer][author]
 
 <!-- Definitions -->
 
-[travis-badge]: https://img.shields.io/travis/wooorm/mdast-util-heading-range.svg
+[build-badge]: https://img.shields.io/travis/wooorm/mdast-util-heading-range.svg
 
-[travis]: https://travis-ci.org/wooorm/mdast-util-heading-range
+[build-status]: https://travis-ci.org/wooorm/mdast-util-heading-range
 
 [coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/mdast-util-heading-range.svg
 
-[coverage]: https://codecov.io/github/wooorm/mdast-util-heading-range
+[coverage-status]: https://codecov.io/github/wooorm/mdast-util-heading-range
 
-[mdast]: https://github.com/wooorm/mdast
+[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg
 
-[mdast-node]: https://github.com/wooorm/mdast#node
-
-[npm-install]: https://docs.npmjs.com/cli/install
+[chat]: https://gitter.im/wooorm/remark
 
 [releases]: https://github.com/wooorm/mdast-util-heading-range/releases
 
 [license]: LICENSE
 
-[home]: http://wooorm.com
+[author]: http://wooorm.com
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[mdast]: https://github.com/wooorm/mdast
+
+[node]: https://github.com/wooorm/mdast#node
+
+[onrun]: #function-onrunstart-nodes-end-scope