Update usage banner for CLI

meganemura · Mar 17, 2015 · cafbb0e · cafbb0e
1 parent 3238007
commit cafbb0e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7,7 +7,16 @@
 
 ## Usage
 
-`sloc <target(s)>` to display SLOC (source lines of code)
+`sloc [options] fil1, file2, ...` to display SLOC (source lines of code)
+
+```
+$ sloc
+Usage: sloc [options] fil1, file2, ...
+    -h, --help       Display this help message.
+    -o, --order      Specify key to order by.
+        --desc       Reverse order if specified.
+    -l, --limit      Specify key to set limitation of displaying file number.
+```
 
 ## Credits
 

diff --git a/lib/sloc/cli.rb b/lib/sloc/cli.rb
@@ -34,6 +34,8 @@ def setup(args)
 
     def parse_options(args)
       opts = Slop.parse!(args) do |o|
+        o.banner 'Usage: sloc [options] fil1, file2, ...'
+
         o.on('-h', '--help', 'Display this help message.')
         o.on('-o', '--order=', 'Specify key to order by.')
         o.on('--desc', 'Reverse order if specified.')