Merge branch 'master' of https://github.com/sendgrid/nodejs-http-client

Author: dhsrocha

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,31 @@
+<!-- 
+Please explain WHAT you changed and WHY. 
+
+The title should be descriptive, for example:
+
+* *Fixed a typo in the apikeypermissions.md page*
+* *Added the maximum number of domain whitelabels you can create to domains.md*
+* *Fixing the number of days a batch id is valid in scheduling_parameters.md*
+
+If this PR fixes an issue, please reference the issue number as well.
+
+Fill out this form in the body:
+-->
+
+**Description of the change**:
+
+**Reason for the change**:
+
+**Link to original source**:
+
+### Checklist
+
+Make sure all of these items are complete, or else the PR will be ineligible for a code review.
+
+- [ ] Code passes all existing [tests](https://github.com/sendgrid/nodejs-http-client/tree/master/test)
+- [ ] Any new functionality added includes new unit tests in [`test/test.js`](https://github.com/sendgrid/nodejs-http-client/tree/master/test/test.js)
+- [ ] Create or update example code to show the new functionality in action.
+- [ ] All code, branch, and git naming and style conventions are followed (see [`CONTRIBUTING.md`](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#style-guidelines--naming-conventions))
+- [ ] Feature branch has been rebased off of the latest `master` branch. ( see [`CONTRIBUTING.md`](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#creating-a-pull-request) ).
+
+If you have questions, please send an email [Sendgrid](mailto:[email protected]), or file a Github Issue in this repository.

README.md

@@ -96,7 +96,7 @@ echo "sendgrid.env" >> .gitignore
 source ./sendgrid.env
 ```
 
-You cand use the ```.env_example``` file located at "examples" folder. Just copy it to a ```.env``` folder ou can put on your project's root.
+You can use the ```.env_example``` file located at "examples" folder. Just copy it to a ```.env``` folder ou can put on your project's root.
 
 Here is the [full working code](https://github.com/sendgrid/nodejs-http-client/blob/master/examples/example.js).
 
@@ -105,6 +105,8 @@ To run the example:
 ```bash
 node examples/example
 ```
+=======
+[Library Usage Documentation](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md)
 
 <a name="roadmap"></a>
 # Roadmap
@@ -129,4 +131,4 @@ nodejs-http-client is maintained and funded by SendGrid, Inc. The names and logo
 
 <a name="license"></a>
 # License
-[The MIT License (MIT)](LICENSE.txt)
+[The MIT License (MIT)](LICENSE.txt)

USAGE.md

@@ -0,0 +1,17 @@
+Following is an example using SendGrid. You can get your free account [here](https://sendgrid.com/free?source=nodejs-http-client).
+
+First, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
+
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
+```
+
+Here is the [full working code](https://github.com/sendgrid/nodejs-http-client/blob/master/examples/example.js).
+
+To run the example:
+
+```bash
+node examples/example
+```