Skip to content

docs: add usage.md #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 30, 2017
Merged

docs: add usage.md #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9fbda8e
add usage.md
rohitdaryanani Oct 27, 2017
2f6584a
Merge branch 'master' into master
Oct 30, 2017
b20a938
Merge branch 'master' into master
Oct 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All updates to this module are documented in our [CHANGELOG](https://github.com/
# Table of Contents
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Library Usage Documentation](USAGE.md)
- [Roadmap](#roadmap)
- [How to Contribute](#contribute)
- [About](#about)
Expand Down Expand Up @@ -79,9 +79,6 @@ console.log(header.jsonString());
<a name="usage"></a>
# Usage

- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
- [Example Code](https://github.com/sendgrid/smtpapi-nodejs/blob/master/examples)

<a name="roadmap"></a>
# Roadmap

Expand Down
4 changes: 4 additions & 0 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ Using the .esdoc.json file, esdoc will create documentation in the docs director
## 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
- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great start. Can you please add some more information? The SMTPAPI-PHP usage file is more in-line with what we were looking for, can you give that a look and make a similar file here?

- [Example Code](https://github.com/sendgrid/smtpapi-nodejs/blob/master/examples)