Added Usage info from script

huntcsg · Mar 20, 2016 · acebe91 · acebe91
1 parent 8e54781
commit acebe91
Showing 1 changed file with 72 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,3 +4,75 @@
 | master     | [![Build Status](https://travis-ci.org/huntcsg/bragly.svg?branch=master)](https://travis-ci.org/huntcsg/bragly)|[![Coverage Status](https://coveralls.io/repos/github/huntcsg/bragly/badge.svg?branch=master)](https://coveralls.io/github/huntcsg/bragly?branch=master)|
 
 A command line tool to help remind you of your accomplishments
+
+####Base executable
+
+```
+$ brag --help
+usage: brag [-h] {w,r,s} ...
+
+positional arguments:
+  {w,r,s}     sub command help
+    w         Write a new brag entry
+    r         Read a group of brag entries
+    s         Search for a group of brag entries
+
+optional arguments:
+  -h, --help  show this help message and exit
+```
+####Write
+```
+$ brag w --help
+usage: brag w [-h] [-t [TAGS [TAGS ...]]] [-d TIMESTAMP] message [message ...]
+
+positional arguments:
+  message               The brag message
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -t [TAGS [TAGS ...]], --tags [TAGS [TAGS ...]]
+                        The tags associated with this brag message
+  -d TIMESTAMP, --timestamp TIMESTAMP
+                        The time stamp to use for this entry, in ISO-8601
+                        format
+```
+####Read
+```
+$ brag r --help
+usage: brag r [-h] [-s START] [-p PERIOD | -e END] [-f FORM]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -s START, --start START
+                        The start time for getting entries
+  -p PERIOD, --period PERIOD
+                        The time period after the start datetime to get
+                        entires. One of hour, day, week, month, year
+  -e END, --end END     The end time for getting entries
+  -f FORM, --form FORM  The format to display the results in. One of json,
+                        json-pretty, log. Default: json
+```
+####Search
+```
+$ brag s --help
+usage: brag s [-h] [-s START] [-p PERIOD | -e END] [-t [TAGS [TAGS ...]]]
+              [-x [TEXT [TEXT ...]]] [-f FORM]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -s START, --start START
+                        The start time for getting entries
+  -p PERIOD, --period PERIOD
+                        The time period after the start datetime to get
+                        entires. One of hour, day, week, month, year
+  -e END, --end END     The end time for getting entries
+  -t [TAGS [TAGS ...]], --tags [TAGS [TAGS ...]]
+                        Tags you want to search for
+  -x [TEXT [TEXT ...]], --text [TEXT [TEXT ...]]
+                        Keywords you want to search for
+  -f FORM, --form FORM  The format to display the results in. One of json,
+                        json-pretty, log. Default: json
+```
+```
+
+