Added esdoc support

.esdoc.json

@@ -0,0 +1,13 @@
+{
+    "source": "./packages",
+    "destination": "./docs",
+    "plugins": [
+      {
+        "name": "esdoc-coverage-plugin", 
+        "option": {
+          "enable": true,
+          "kind": ["class", "method", "member", "get", "set", "constructor", "function", "variable"]
+        }
+      }
+    ]
+  }

.gitignore

@@ -6,3 +6,4 @@ test/config.js
 *.log
 .vscode/
 prism_darwin_amd64
+docs/

CONTRIBUTING.md

@@ -131,6 +131,7 @@ Generally, we follow the style guidelines as suggested by the official language.
 Please run your code through:
 
 - [ESLint](http://eslint.org/) with the standard style guide.
+- [esdoc](https://github.com/sendgrid/sendgrid-nodejs/blob/master/.github/USAGE.md) to check the documentation coverage of your added code.
 
 ## Creating a Pull Request<a name="creating-a-pull-request"></a>
 

.github/USAGE.md → USAGE.md

@@ -8,3 +8,16 @@ This USAGE.md contains information pertaining to all packages. For examples on h
 * [@sendgrid/inbound-mail-parser](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/inbound-mail-parser) - help with parsing the SendGrid Inbound Parse API
 * [@sendgrid/contact-importer](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/contact-importer) - help with importing contacts into the ContactDB
 * [@sendgrid/helpers](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/helpers) - a collection of classes and helpers used internally by the above packages
+
+
+# Documentation
+
+If you would like to auto-generate documentation of the packages, you can do so locally by running:
+```
+./node_modules/.bin/esdoc
+```
+Using the .esdoc.json file, esdoc will create documentation in the docs directory. 
+
+## Checking docs coverage
+
+You will find a coverage.json file in the docs directory. This will contain information about the documentation coverage for each of the different files in this repo.

package.json

@@ -34,5 +34,22 @@
     "test:typescript": "tsc",
     "test": "npm run test:all -s",
     "coverage": "open -a \"Google Chrome\" ./coverage/lcov-report/index.html"
-  }
+  },
+  "description": "![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)",
+  "bugs": {
+    "url": "https://github.com/sendgrid/sendgrid-nodejs/issues"
+  },
+  "homepage": "https://github.com/sendgrid/sendgrid-nodejs#readme",
+  "main": "index.js",
+  "directories": {
+    "doc": "docs",
+    "test": "test"
+  },
+  "dependencies": {
+    "chai": "^2.3.0",
+    "esdoc": "^1.0.3",
+    "esdoc-coverage-plugin": "^1.1.0",
+    "esdoc-type-inference-plugin": "^1.0.1"
+  },
+  "author": "SendGrid"
 }