X-Git-Url: https://git.xandkar.net/?p=beam_stats.git;a=blobdiff_plain;f=README.md;h=22fb510a75cb4196002b4f8dd5a05ce22eee1005;hp=09d28d3a736bb01ed053f8ee9902bc46389a1d23;hb=c59a1bccb86e90a68f088184e9e491217de87da6;hpb=b545475b0a1ae7d01648ba5798a803c97bf28582

diff --git a/README.md b/README.md
index 09d28d3..22fb510 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
+[![Build Status](https://travis-ci.org/ibnfirnas/beam_stats.svg?branch=master)](https://travis-ci.org/ibnfirnas/beam_stats)
+
 beam_stats
 ==========
 
 Periodically collects and pushes VM metrics to arbitrary consumers. Defaults to
-StatsD and includes off-by-default implementations for Graphite
-(`beam_stats_consumer_graphite`) and CSV file (`beam_stats_consumer_csv`)
-consumers).
+StatsD (`beam_stats_consumer_statsd`) and includes off-by-default
+implementations for Graphite (`beam_stats_consumer_graphite`) and CSV file
+(`beam_stats_consumer_csv`) consumers).
 
 Essentially like `folsomite`, but better. Better in the following ways:
 
@@ -15,3 +17,35 @@ Essentially like `folsomite`, but better. Better in the following ways:
   conversions, as opposed to the nearly-arbitrary term-to-string conversions
   used in `folsomite`
 - Spec'd, tested and Dialyzed
+
+#### Configure consumers
+
+```erlang
+{env,
+  [ {production_interval , 30000}
+  , {consumers,
+      [ {beam_stats_consumer_statsd,
+          [ {consumption_interval , 60000}
+          , {dst_host             , "localhost"}
+          , {dst_port             , 8125}
+          , {src_port             , 8124}
+          ]}
+      , {beam_stats_consumer_graphite,
+          [ {consumption_interval , 60000}
+          , {host                 , "localhost"}
+          , {port                 , 2003}
+          , {timeout              , 5000}
+          ]}
+      , {beam_stats_consumer_csv,
+          [ {consumption_interval , 60000}
+          , {path                 , "beam_stats.csv"}
+          ]}
+
+      , {some_custom_consumer_module,
+          [ {foo, "abc"}
+          , {bar, 123}
+          ]}
+
+      ]}
+  ]}
+```