Add examples to readme.

mkdoc · Mar 21, 2016 · a599708 · a599708
1 parent 84bf16d
commit a599708
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -29,6 +29,26 @@ ast.src('## Heading\n\nParagraph.')
   .pipe(process.stdout);
 ```
 
+## Examples
+
+Remove all headings from a document:
+
+```shell
+mkcat README.md | mkfilter --heading | mkout
+```
+
+Remove everything but headings and text from a document:
+
+```shell
+mkcat README.md | mkfilter --heading --text --invert | mkout
+```
+
+Print code blocks in a document:
+
+```shell
+mkcat README.md | mkfilter --code-block --invert | mkout
+```
+
 ## Help
 
 ```

diff --git a/doc/readme.md b/doc/readme.md
@@ -14,7 +14,7 @@ Create the stream and write a [commonmark][] document:
 
 <? @source {javascript=s/\.\.\/index/mkfilter/gm} usage.js ?>
 
-<? @include readme/help.md ?>
+<? @include {=readme} examples.md help.md ?>
 
 <? @exec mkapi index.js --title=API --level=2 ?>
 <? @include {=readme} license.md links.md ?>
diff --git a/doc/readme/examples.md b/doc/readme/examples.md
@@ -0,0 +1,19 @@
+## Examples
+
+Remove all headings from a document:
+
+```shell
+mkcat README.md | mkfilter --heading | mkout
+```
+
+Remove everything but headings and text from a document:
+
+```shell
+mkcat README.md | mkfilter --heading --text --invert | mkout
+```
+
+Print code blocks in a document:
+
+```shell
+mkcat README.md | mkfilter --code-block --invert | mkout
+```