twilio report poc

[m6w6/btr] / README.md

diff --git a/README.md b/README.md
index e36ea38d008bd976ea1eb5b4431734b7477015a1..f482cc8c70cd541c9de1e11a8344d33e9efc686d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,41 @@
 # btr
 
+A poor man's CI tool.
+
 ## BUILD TEST REPORT
 
 A simple tool to automate reporting of build and test results.
 
 ### Currently supported rulesets:
 
-* source: git, svn
-* build: php, pecl
-* report: mail
+* ***source:*** git, svn
+* ***build:*** php, pecl, gnu
+* ***report:*** mail, notify-send
+
+#### Usage
+```
+Usage: btr [-hv] [<options>] <repository>
+
+    -h, --help      Display this help
+    -v, --verbose   Be more verbose
+
+  Options:
+    -s, --source=<rules>          Use the specified source ruleset
+    -b, --build=<rules>           Use the specified build ruleset
+    -r, --report=<rules>          Use the specifued report ruleset
+    -B, --branch=<branch>         Checkout this branch
+    -D, --directory=<directory>   Use this directory as work root
+    -S, --suffix=<suffix>         Append suffix to the build name
+    -C, --configure=<options>     Define $CONFIGURE options
+
+  Rulesets:
+        source: git svn
+         build: gnu pecl php
+        report: mail notify-send
+```
+#### Examples
+
+`./bin/btr -s svn -b pecl -r mail -v https://svn.php.net/repository/pecl/http -B branches/DEV_2`
+
+`USER=mike@php.net TESTS=tests/output ./bin/btr -s git -b php -r mail git@git.php.net:php-src.git`
+