twilio report poc
[m6w6/btr] / README.md
index 04bab764e0e04204dd3e1bbe997f750d62ae9520..f482cc8c70cd541c9de1e11a8344d33e9efc686d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,16 @@
 # 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
 ```
@@ -27,13 +29,13 @@ Usage: btr [-hv] [<options>] <repository>
     -C, --configure=<options>     Define $CONFIGURE options
 
   Rulesets:
-    source: git
-    build:  php
-    report: mail
+        source: git svn
+         build: gnu pecl php
+        report: mail notify-send
 ```
 #### Examples
 
-`USER=mike@php.net ./bin/btr -s svn -b pecl -r mail -v https://svn.php.net/repository/pecl/http -B branches/DEV_2`
+`./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`