Permalink
Browse files

basic readme

  • Loading branch information...
1 parent 4127283 commit 08fc390749eecb623b6af2fddd7672db2c1bb71b Steve Ivy committed Feb 25, 2011
Showing with 12 additions and 0 deletions.
  1. +12 −0 README.md
View
@@ -0,0 +1,12 @@
+# node-statsd
+
+A node.js client for [Etsy](http://etsy.com)'s [StatsD](https://github.com/etsy/statsd) server.
+
+This client will let you fire stats at your StatsD server from a node.js application.
+
+ > require('./statsd').StatsD
+ > c = new StatsD('example.org',1234)
+ { host: 'rayners.org', port: 8125 }
+ > c.increment('node_test.int')
+ > c.decrement('node_test.int')
+ > c.timing('node_test.some_service.task.time', 500) // time in millis

0 comments on commit 08fc390

Please sign in to comment.