Add basic reporter example.

mikejihbe · Mar 15, 2016 · d120d1e · d120d1e
1 parent bde4731
commit d120d1e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,18 @@ metricsServer.addMetric('com.co.thingD', meter);
 metricsServer.addMetric('com.co.thingE', timer);
 ```
 
+**Setting up a Reporter**
+
+A reporting interface exists for reporting metrics on a recurring interval.  Reporters can be found in [reporting/](reporting).
+
+```javascript
+// Report to console every 1000ms.
+var report = new metrics.Report();
+report.addMetric('com.co.thingA', counter);
+var reporter = new metrics.ConsoleReporter(report);
+
+reporter.start(1000);
+```
 
 Advanced Usage
 --------------