Skip to content
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.

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

docs: Ran .md files through Grammer.ly #84

Merged
merged 1 commit into from
Aug 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,12 @@ All notable changes to this project will be documented in this file.
[2017-04-10] Version 1.3.1
--------------------------
### Fixed
- #16 fix issue where concat was used incorrectly
- #16 Fixed issue where concat was used incorrectly.
- Thanks to [Limian Wang](https://github.com/limianwang) for the PR!

## [1.3.0] - 2017-4-6
### Added
- #19 Adds setBatchId method
- #19 Adds setBatchId method.
- Thanks to [mell0kat](https://github.com/mell0kat) for the PR!

## [1.2.0] - 2015-7-19
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.

- [Feature Request](#feature-request)
- [Submit a Bug Report](#submit-a-bug-report)
Expand Down Expand Up @@ -29,7 +29,7 @@ A software bug is a demonstrable issue in the code base. In order for us to diag
Before you decide to create a new issue, please try the following:

1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
2. Update to the latest version of this code and check if issue has already been fixed
2. Update to the latest version of this code and check if the issue has already been fixed
3. Copy and fill in the Bug Report Template we have provided below

### Please use our Bug Report Template
Expand All @@ -41,17 +41,17 @@ In order to make the process easier, we've included a [sample bug report templat

We welcome direct contributions to the smtpapi-nodejs code base. Thank you!

### Development Environment ###
### Development Environment

#### Install and Run Locally ####
#### Install and Run Locally

##### Prerequisites #####
##### Prerequisites

- Node.js version 0.10, 0.12 or 4
- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=smtpapi-nodejs)
- Please see [package.json](package.json)

##### Initial setup: #####
##### Initial setup:

```bash
git clone https://github.com/sendgrid/smtpapi-nodejs.git
Expand All @@ -72,7 +72,7 @@ echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
```

##### Execute: #####
##### Execute:

See the [examples folder](examples) to get started quickly.

Expand Down Expand Up @@ -175,7 +175,7 @@ Please run your code through:
```

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.

<a name="code-reviews"></a>
## Code Reviews
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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());
```

Expand Down
11 changes: 6 additions & 5 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ If you can't find a solution below, please open an [issue](https://github.com/se

## Table of Contents

* [Versions](#versions)
* [Using the Package Manager](#package-manager)
* [Viewing the Request Body](#stmpapi-header)
- [Table of Contents](#table-of-contents)
- [Versions](#versions)
- [Using the Package Manager](#using-the-package-manager)
- [Outputting the STMPAPI Header](#outputting-the-stmpapi-header)

<a name="versions"></a>
## Versions

We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) section.
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) section.

<a name="package-manager"></a>
## Using the Package Manager
Expand Down Expand Up @@ -57,4 +58,4 @@ or use it in your options for the transport (Nodemailer example):
...
headers: headers
}
```
```
5 changes: 4 additions & 1 deletion USAGE.md
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)