From 4d82621cc029a72eea51e0d1a3ebd3c8bc550472 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20G=C3=BCnther?= Date: Tue, 5 May 2015 15:15:16 +0200 Subject: [PATCH] Updates to documentations --- lib/index.js | 15 ++++++++++++++- package.json | 5 +++-- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/lib/index.js b/lib/index.js index 08f06fa..9e4ef18 100644 --- a/lib/index.js +++ b/lib/index.js @@ -11,13 +11,26 @@ require("./api")(module.exports); * * app_key: your app key * * api_version: the version of the api [default: `v1`] * * api_host: the host to call [default: `api.datadoghq.com`] + * * proxy_agent: Optional, A Https Proxy agent. *example: * | * ```javascript * var dogapi = require("dogapi"); + * + * // Optional for Proxy -------8<---------- + * // Code from http://blog.vanamco.com/proxy-requests-in-node-js/ + * var HttpsProxyAgent = require("./httpsproxyagent"); + * + * var agent = new HttpsProxyAgent({ + * proxyHost: "MY_PROXY_HOST", + * proxyPort: 3128 + * }); + * // Optional for Proxy -------->8---------- + * * var options = { * api_key: "", - * app_key: "" + * app_key: "", + * proxy_agent: agent // Optional for Proxy * }; * dogapi.initialize(options); * dogapi.event.create(...); diff --git a/package.json b/package.json index f639aa1..e8f198b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "dogapi", - "version": "1.0.0", + "version": "1.0.1", "description": "Datadog API Node.JS Client", "main": "lib/index.js", "scripts": { @@ -25,7 +25,8 @@ "author": "Brett Langdon (http://brett.is)", "contributors": [ "colinjonesx (http://www.thetestpeople.com)", - "dalehamel (http://blog.srvthe.net)" + "dalehamel (http://blog.srvthe.net)", + "egut (https://github.com/egut)" ], "license": "MIT", "readmeFilename": "README.md",