docs

75lb · May 28, 2016 · 64c298f · 64c298f
1 parent baf6ce6
commit 64c298f
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ A usage guide is built from an arbitrary number of sections, e.g. a description
 
 The `commandLineUsage()` function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either `content` or `optionList`.
 
+Inline ansi formatting can be used anywhere within the usage template using the formatting syntax described [here](https://github.com/75lb/ansi-escape-sequences#module_ansi-escape-sequences.format).
+
 ```js
 const getUsage = require('command-line-usage')
 
@@ -37,7 +39,7 @@ const usage = getUsage(sections)
 console.log(usage)
 ```
 
-Inline ansi formatting can be used anywhere within the usage template using the formatting syntax described [here](https://github.com/75lb/ansi-escape-sequences#module_ansi-escape-sequences.format).
+![usage](https://raw.githubusercontent.com/75lb/command-line-usage/next/example/screens/simple.png)
 
 ## Examples
 

diff --git a/example/screens/custom.png b/example/screens/custom.png
diff --git a/example/screens/synopsis.png b/example/screens/synopsis.png
diff --git a/jsdoc2md/README.hbs b/jsdoc2md/README.hbs
@@ -12,6 +12,8 @@ A usage guide is built from an arbitrary number of sections, e.g. a description
 
 The `commandLineUsage()` function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either `content` or `optionList`.
 
+Inline ansi formatting can be used anywhere within the usage template using the formatting syntax described [here](https://github.com/75lb/ansi-escape-sequences#module_ansi-escape-sequences.format).
+
 ```js
 const getUsage = require('command-line-usage')
 
@@ -37,7 +39,7 @@ const usage = getUsage(sections)
 console.log(usage)
 ```
 
-Inline ansi formatting can be used anywhere within the usage template using the formatting syntax described [here](https://github.com/75lb/ansi-escape-sequences#module_ansi-escape-sequences.format).
+![usage](https://raw.githubusercontent.com/75lb/command-line-usage/next/example/screens/simple.png)
 
 ## Examples