Merge pull request #3 from ibnfirnas/per-process-stats

[beam_stats.git] / README.md

diff --git a/README.md b/README.md
index aba81ed..3a55536 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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,7 @@ Essentially like `folsomite`, but different. Different in the following ways:
           , {dst_host             , "localhost"}
           , {dst_port             , 8125}
           , {src_port             , 8124}
+          , {num_msgs_per_packet  , 10}
           ]}
       , {beam_stats_consumer_graphite,
           [ {consumption_interval , 60000}
@@ -52,3 +55,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.