Test with OTP releases 21.[0..3]

[beam_stats.git] / README.md

diff --git a/README.md b/README.md
index aba81ed..4402288 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/ibnfirnas/beam_stats.svg?branch=master)](https://travis-ci.org/ibnfirnas/beam_stats)
+[![Build Status](https://travis-ci.org/xandkar/beam_stats.svg?branch=master)](https://travis-ci.org/xandkar/beam_stats)
 
 beam_stats
 ==========
@@ -22,7 +22,9 @@ Essentially like `folsomite`, but different. Different in the following ways:
       nearly-arbitrary term-to-string conversions used in `folsomite`
     + Spec'd, tested and Dialyzed
 
-#### Configure consumers
+### Adding consumers
+
+#### At app config time
 
 ```erlang
 {env,
@@ -33,6 +35,11 @@ Essentially like `folsomite`, but different. Different in the following ways:
           , {dst_host             , "localhost"}
           , {dst_port             , 8125}
           , {src_port             , 8124}
+          , {num_msgs_per_packet  , 10}
+
+          % If you want to name your node something other than what
+          % erlang:node() returns:
+          , {static_node_name     , <<"unicorn_at_rainbow">>}
           ]}
       , {beam_stats_consumer_graphite,
           [ {consumption_interval , 60000}
@@ -52,3 +59,13 @@ Essentially like `folsomite`, but different. Different in the following ways:
       ]}
   ]}
 ```
+
+#### Dynamically
+
+```erlang
+beam_stats_consumer:add(consumer_module, ConsumerOptions).
+```
+
+### Removing consumers
+
+Not yet implemented.