-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ran .md files through Grammer.ly an updated accordingly
- Loading branch information
Showing
5 changed files
with
25 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,7 +41,7 @@ echo "sendgrid.env" >> .gitignore | |
source ./sendgrid.env | ||
``` | ||
|
||
The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it. | ||
The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x, therefore, you likely already have it. | ||
|
||
Install smtpapi-nodejs and its dependencies: | ||
|
||
|
@@ -57,10 +57,10 @@ npm install smtpapi | |
# Quick Start | ||
|
||
```javascript | ||
var smtpapi = require('smtpapi'); | ||
var header = new smtpapi(); | ||
header.addTo('[email protected]'); | ||
header.setUniqueArgs({cow: 'chicken'}); | ||
var smtpapi = require("smtpapi"); | ||
var header = new smtpapi(); | ||
header.addTo("[email protected]"); | ||
header.setUniqueArgs({ cow: "chicken" }); | ||
console.log(header.jsonString()); | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,18 @@ | ||
# 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. | ||
|
||
# More information | ||
# More information | ||
|
||
- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html) | ||
- [Example Code](examples) |