Permalink
Browse files

Added readme

  • Loading branch information...
0 parents commit a02107340891b7e8423437e4c57e1fd6657ef199 Mark Cahill committed Sep 6, 2011
Showing with 14 additions and 0 deletions.
  1. +14 −0 readme.md
@@ -0,0 +1,14 @@
+The goal of node-telemtry is to make it really easy to deploy a scalable telemetry
+server for small projects. This can be used to capture errors, performance data,
+and more, and store it in a document store. Arbitrary inputs are supported by some
+backends, and of course any parameters may be attached to each document.
+
+To install telemetry, run
+
+ npm install -g telemetry
+
+then edit your config.yaml, and run telemetry:
+
+ telemetry
+
+For more information, visit [the wiki](https://github.com/thinkjson/node-telemetry/wiki).

0 comments on commit a021073

Please sign in to comment.