From e1dbc417208f4d014aacb7d16d4861106746afef Mon Sep 17 00:00:00 2001 From: Brett Langdon Date: Thu, 28 Mar 2013 18:39:44 -0300 Subject: [PATCH] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 183682f..f1e19cf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,50 @@ node-dogapi =========== -Datadog API Node.JS Client \ No newline at end of file +Datadog API Node.JS Client modeled after `Datadog/dogapi` python client. + +Official API Documentation: http://docs.datadoghq.com/api/ + +## Installation + +**From NPM:** +```bash +[sudo] npm install dogapi +``` + +**From source:** +```bash +git clone git://github.com/brettlangdon/node-dogapi.git +cd ./node-dogapi +npm install +``` + +## Sample Usage: + +**Example:** get all events since this time yesterday: +```javascript +var dogapi = require('dogapi'); + +var options = { + api_key: 'YOUR_KEY_HERE', + app_key: 'YOUR KEY_HERE', +}; + +var api = new dogapi(options); + +var end = parseInt(new Date().getTime() / 1000); +var start = end - 86400; + +api.stream(start, end, function(error, result, status_code){ + if(error){ + console.log('Error: ', error); + console.log('Status Code: ', status_code); + return; + } + + result['events'].forEach(function(event){ + console.log(event['id'] + ': ' + event['title']); + }); +}); + +```