Browse Source

Updates to documentations

pull/14/head
Erik Günther 11 years ago
parent
commit
4d82621cc0
2 changed files with 17 additions and 3 deletions
  1. +14
    -1
      lib/index.js
  2. +3
    -2
      package.json

+ 14
- 1
lib/index.js View File

@ -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: "<API_KEY_HERE>",
* app_key: "<APP_KEY_HERE>"
* app_key: "<APP_KEY_HERE>",
* proxy_agent: agent // Optional for Proxy
* };
* dogapi.initialize(options);
* dogapi.event.create(...);


+ 3
- 2
package.json View File

@ -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 <brett@blangdon.com> (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",


Loading…
Cancel
Save