docs: extend documentation in -h

kantord · Mar 8, 2019 · 87c08be · 87c08be
1 parent d9d118c
commit 87c08be
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,6 +21,13 @@ OPTIONS
   -s, --script-file=script-file  read script from file
   -u, --ugly                     don't prettify output
   -v, --version                  show CLI version
+
+DESCRIPTION
+  Example:
+
+       cat input.json | emuto '$.characters | map ($ => $ { name gender})'
+
+  The shebang for emuto is #! emuto -s
 </pre>
 
 # Setup

diff --git a/src/emuto.js b/src/emuto.js
@@ -28,7 +28,13 @@ const createEmutoCliCommand = ({getStdin, fs}) => {
 
   EmutoCliCommand.args = [{name: 'filter', required: false}]
 
-  EmutoCliCommand.description = 'process JSON files'
+  EmutoCliCommand.description = `process JSON files
+
+  Example:
+
+    cat input.json | emuto '$.characters | map ($ => $ { name gender})'
+
+The shebang for emuto is #! emuto -s`
 
   EmutoCliCommand.flags = {
     version: flags.version({char: 'v'}),