X-Git-Url: https://git.xandkar.net/?a=blobdiff_plain;f=README.md;h=ef777748fb531f8b52c44b0b492a233e1f33cfb1;hb=012258d9a092cc6356ee1d991579d15ae0128718;hp=12e2e3c0d60e086f0dba8d74c632c95afed86550;hpb=caf75ed8160362773766c6bde005cf5f33544392;p=beam_stats.git

diff --git a/README.md b/README.md
index 12e2e3c..ef77774 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +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 (Graphite
-and CSV by default).
+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).
 
 Essentially like `folsomite`, but better. Better in the following ways:
 
@@ -13,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}
+          ]}
+
+      ]}
+  ]}
+```