From: Siraaj Khandkar <siraaj@khandkar.net>
Date: Thu, 20 Aug 2015 16:33:32 +0000 (-0400)
Subject: Add configuration example to README
X-Git-Tag: 0.0.0~2
X-Git-Url: https://git.xandkar.net/?a=commitdiff_plain;h=875ffc3ab4ea693fac1f3278b4c6429012158a89;p=beam_stats.git

Add configuration example to README
---

diff --git a/README.md b/README.md
index 09d28d3..8c1ec4c 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,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}
+          ]}
+
+      ]}
+  ]}
+```