Permalink
Browse files

Readme

  • Loading branch information...
1 parent 0808e46 commit 0499f244ca09d877e8220c4f649dbcd24b42f717 @felixge committed Oct 31, 2011
Showing with 32 additions and 0 deletions.
  1. +32 −0 Readme.md
View
@@ -0,0 +1,32 @@
+# graphite
+
+A node.js client for graphite.
+
+## Is it any good?
+
+Try it : ).
+
+## Usage
+
+Sending data:
+
+```js
+var graphite = require('graphite');
+var carbonClient = graphite.createCarbonClient('plaintext://your-graphite-host/');
+
+var key = 'foo.bar.baz';
+var value = 23;
+carbonClient.write(key, value, function(err) {
+ if (err) throw err;
+});
+```
+
+## Todo
+
+* More docs
+* Maybe implement the pickle / AMQP protocols for sending data
+* Unit tests
+
+## License
+
+Licensed under the MIT license.

0 comments on commit 0499f24

Please sign in to comment.