Update the readme.

mkdoc · Mar 20, 2016 · e8f880b · e8f880b
1 parent d912c1b
commit e8f880b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ For the command line interface install [mkdoc][] globally (`npm i -g mkdoc`).
 
 ## Usage
 
-Create a task file like this one ([source file](https://github.com/mkdoc/mktask/blob/master/mkdoc.js)):
+Create a `mkdoc.js` task file like this one ([source file](https://github.com/mkdoc/mktask/blob/master/mkdoc.js)):
 
 ```javascript
 var mk = require('mktask');
@@ -38,18 +38,24 @@ function readme(cb) {
 mk.task(readme);
 ```
 
-And build README.md using:
+Then you can build all tasks using:
 
 ```shell
 mk
 ```
 
-Or more explicitly:
+Or specific tasks:
 
 ```shell
 mk readme
 ```
 
+To see a list of the tasks use:
+
+```shell
+mk --tasks
+```
+
 ## Guide
 
 This guides assumes you are using the `mk` program to run tasks, install it with `npm i -g mkdoc`.

diff --git a/doc/readme.md b/doc/readme.md
@@ -10,22 +10,28 @@ Runs named task functions that return streams, arrays of deferred task functions
 
 ## Usage
 
-Create a task file like this one ([source file](/mkdoc.js)):
+Create a `mkdoc.js` task file like this one ([source file](/mkdoc.js)):
 
 <? @source {javascript=s/\.\/index/mktask/gm} ../mkdoc.js ?>
 
-And build README.md using:
+Then you can build all tasks using:
 
 ```shell
 mk
 ```
 
-Or more explicitly:
+Or specific tasks:
 
 ```shell
 mk readme
 ```
 
+To see a list of the tasks use:
+
+```shell
+mk --tasks
+```
+
 <? @include {=readme} guide.md ?>
 
 <? @exec mkapi *.js --title=API --level=2 ?>