Skip to content

Commit

Permalink
docs: Run *.md documents through Grammer.ly (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssiddhantsharma committed Aug 14, 2020
1 parent 32c7554 commit f766ce2
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 50 deletions.
32 changes: 16 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Change Log
All notable changes to this project will be documented in this file.
All the notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](http://semver.org/).

Expand Down Expand Up @@ -45,40 +45,40 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- PR [#24](https://github.com/sendgrid/smtpapi-go/pull/24): Added Code of Conduct. Big thanks to [Shivam Agarwal](https://github.com/gr8shivam) for the PR!
- PR [#26](https://github.com/sendgrid/smtpapi-go/pull/26): Added TROUBLESHOOTING.md. Big thanks to [Callam Delaney](https://github.com/cal97g) for the PR!
- PR [#30](https://github.com/sendgrid/smtpapi-go/pull/30): SEO updates. Big thanks to [Eric Liu](https://github.com/eric1iu) for the PR!
- PR [#32](https://github.com/sendgrid/smtpapi-go/pull/32): Add table of contents to README.md. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!
- PR [#29](https://github.com/sendgrid/smtpapi-go/pull/29): README.md updates. Big thanks to [Andrew Hamilton](https://github.com/ahamilton55) for the PR!
- PR [#36](https://github.com/sendgrid/smtpapi-go/pull/36): Add .github/ISSUE_TEMPLATE. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!
- PR [#32](https://github.com/sendgrid/smtpapi-go/pull/32): Added table of contents to README.md. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!
- PR [#29](https://github.com/sendgrid/smtpapi-go/pull/29): Added README.md updates. Big thanks to [Andrew Hamilton](https://github.com/ahamilton55) for the PR!
- PR [#36](https://github.com/sendgrid/smtpapi-go/pull/36): Added .github/ISSUE_TEMPLATE. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!
- PR [#31](https://github.com/sendgrid/smtpapi-go/pull/31): Parallelize all tests. Big thanks to [Vasko Zdravevski](https://github.com/vaskoz) for the PR!
- PR [#38](https://github.com/sendgrid/smtpapi-go/pull/38): Create PULL_REQUEST_TEMPLATE. Big thanks to [Anatoly](https://github.com/anatolyyyyyy) for the PR!
- PR [#38](https://github.com/sendgrid/smtpapi-go/pull/38): Created PULL_REQUEST_TEMPLATE. Big thanks to [Anatoly](https://github.com/anatolyyyyyy) for the PR!
- PR [#51](https://github.com/sendgrid/smtpapi-go/pull/51): Don't ignore erros in test. Big thanks to [Revolta](https://github.com/keydrevolta) for the PR!
- PR [#52](https://github.com/sendgrid/smtpapi-go/pull/52): Include Gometalinter in Travis CI build. Big thanks to [Vasko Zdravevski](https://github.com/vaskoz) for the PR!
- PR [#42](https://github.com/sendgrid/smtpapi-go/pull/42): Add a .env_sample file, update gitignore, update README.md. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!
- PR [#52](https://github.com/sendgrid/smtpapi-go/pull/52): Include Gometalinter in the Travis CI build. Big thanks to [Vasko Zdravevski](https://github.com/vaskoz) for the PR!
- PR [#42](https://github.com/sendgrid/smtpapi-go/pull/42): Added a .env_sample file, updated gitignore, updated README.md. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!
- PR [#44](https://github.com/sendgrid/smtpapi-go/pull/44): Added Usage.md. Big thanks to [Tariq Ibrahim](https://github.com/tariq1890) for the PR!
- PR [#49](https://github.com/sendgrid/smtpapi-go/pull/49): Added tests(License): The end year in the license file should be current year. Big thanks to [Marco Antônio Singer](https://github.com/marcosinger) for the PR!
- PR [#53](https://github.com/sendgrid/smtpapi-go/pull/53): Added tests to check for certain repo files to exist in the repo. Big thanks to [Gabriel Lima](https://github.com/gabrielclima) for the PR!
- PR [#53](https://github.com/sendgrid/smtpapi-go/pull/53): Added tests to check for the certain repo files to exist in the repo. Big thanks to [Gabriel Lima](https://github.com/gabrielclima) for the PR!
- PR [#63](https://github.com/sendgrid/smtpapi-go/pull/63): Adding dynamic data support. Big thanks to [Ron Canada](https://github.com/roncanada) for the PR!

### Fixed
- PR [#21](https://github.com/sendgrid/smtpapi-go/pull/21): README.md typo. Big thanks to [Cícero Pablo](https://github.com/ciceropablo) for the PR!
- PR [#22](https://github.com/sendgrid/smtpapi-go/pull/22): Fixed golint issues, added gitignore and boosted test coverage to 100%. Big thanks to [Tariq Ibrahim](https://github.com/tariq1890) for the PR!
- PR [#22](https://github.com/sendgrid/smtpapi-go/pull/22): Fixed golint issues, added gitignore and boosted the test coverage to 100%. Big thanks to [Tariq Ibrahim](https://github.com/tariq1890) for the PR!
- PR [#33](https://github.com/sendgrid/smtpapi-go/pull/33): Using the right contributors badge for smtpapi-go. Big thanks to [Tariq Ibrahim](https://github.com/tariq1890) for the PR!
- PR [#35](https://github.com/sendgrid/smtpapi-go/pull/35): CONTRIBUTING.md typo. Big thanks to [Alex](https://github.com/pushkyn) for the PR!
- PR [#48](https://github.com/sendgrid/smtpapi-go/pull/48): Update LICENSE.txt year. Big thanks to [Alex](https://github.com/pushkyn) for the PR!
- PR [#35](https://github.com/sendgrid/smtpapi-go/pull/35): Fixed the CONTRIBUTING.md typo. Big thanks to [Alex](https://github.com/pushkyn) for the PR!
- PR [#48](https://github.com/sendgrid/smtpapi-go/pull/48): Update the LICENSE.txt year. Big thanks to [Alex](https://github.com/pushkyn) for the PR!

## [0.5.0] - 2017-06-13
### Added
- PR #20: Support asm_groups_to_display
- Big thanks to [Chris Lee](https://github.com/clee) for the PR!
- A big thanks to [Chris Lee](https://github.com/clee) for the PR!

## [0.4.2] - 2017-05-14
### Added
- PR #19: Improved code coverage
- Big thanks to [Vasko Zdravevski](https://github.com/vaskoz) for the PR!
- PR #19: Improved the code coverage
- A big thanks to [Vasko Zdravevski](https://github.com/vaskoz) for the PR!

## [0.4.1] - 2016-11-15
### Fixed
- PR #16: Add support for non-string filter settings
- Big thanks to [Stephen Young](https://github.com/hownowstephen) for the PR!
- PR #16: Add support for the non-string filter settings
- A big thanks to [Stephen Young](https://github.com/hownowstephen) for the PR!

## [0.4.0] - 2015-7-19
### Added
Expand Down
18 changes: 9 additions & 9 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 considering to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute to your projects and additional help is always welcome. We simply require that you follow the following contribution policies.

- [Feature Request](#feature-request)
- [Submit a Bug Report](#submit-a-bug-report)
Expand All @@ -9,7 +9,7 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
- [Creating a Pull Request](#creating-a-pull-request)
- [Code Reviews](#code-reviews)

We use [Milestones](https://github.com/sendgrid/smtpapi-go/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
We use [Milestones](https://github.com/sendgrid/smtpapi-go/milestones) to help define the current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions, and additional PRs are welcomed and encouraged.

<a name="feature-request"></a>
## Feature Request
Expand All @@ -18,21 +18,21 @@ If you'd like to make a feature request, please read this section.

The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:

- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
- Please be respectful and considerate of others when commenting on issues
- Please **search for existing issues** to ensure we don't have duplicate bugs/feature requests.
- Please be respectful and considerate of others when commenting on issues.

<a name="submit-a-bug-report"></a>
## Submit a Bug Report

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.

A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
A software bug is a demonstrable issue in the code base. For us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.

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
3. Copy and fill in the Bug Report Template we have provided below
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,7 +41,7 @@ In order to make the process easier, we've included a [sample bug report templat
<a name="improvements-to-the-codebase"></a>
## Improvements to the Codebase

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

### Development Environment ###

Expand Down Expand Up @@ -120,7 +120,7 @@ Please run your code through:
git remote add upstream https://github.com/sendgrid/smtpapi-go
```

2. If you cloned a while ago, get the latest changes from upstream:
2. If you cloned this a while ago, get the latest changes from upstream:

```bash
git checkout <dev-branch>
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
# Announcements
**The default branch name for this repository has been changed to `main` as of 07/27/2020.**

All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/smtpapi-go/blob/master/CHANGELOG.md).
All the updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/smtpapi-go/blob/master/CHANGELOG.md).

<a name="installation"></a>
# Installation
Expand All @@ -34,13 +34,13 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
* Go version 1.6
* The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=smtpapi-go)

## Install Package
## Install the Package

```bash
go get github.com/sendgrid/smtpapi-go
```

## Setup Environment Variables
## Setup the Environment Variables

### Environment Variable

Expand Down Expand Up @@ -77,11 +77,11 @@ func main() {

# Roadmap

If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/smtpapi-go/milestones). We would love to hear your feedback.
If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/smtpapi-go/milestones). Your feedback will be highly appreciated.

# How to Contribute

We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/smtpapi-go/blob/master/CONTRIBUTING.md) guide for details.
We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/smtpapi-go/blob/master/CONTRIBUTING.md) guide for more details on contributions.

Quick links:

Expand Down
8 changes: 4 additions & 4 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ If you can't find an issue below, please open an [issue](https://github.com/send
<a name="request-body"></a>
## Viewing the request body

If you are having issues with the SMTPAPI, or it is not acting in the way you expect,
viewing the instructions you are sending is a good place to start your troubleshooting.
If you are having issues with the SMTPAPI, or it is not working in the way you expect,
viewing the instructions that are being sent by you, is a good place to start your troubleshooting.

You can view the headers we are passing to the SendGrid API in the following way.
You can view the headers that we are passing to the SendGrid API in the following way.

```golang
package main
Expand All @@ -37,4 +37,4 @@ You can view the headers we are passing to the SendGrid API in the following way
{"category":["NewUser"]} <nil>
```

Now you can ensure that your headers add up to your desired behaviour.
Now you can ensure that your headers will add up to your desired behaviour.
32 changes: 16 additions & 16 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ header.SetCategories([]string{

The `header.SetCategory` method can be used to set a single specific category.

It is useful for removing previously set categories. And will create a new array with the string you provide.
It is useful for removing the previously set categories and it will create a new array with the string you provide.

This method will remove any categories that have been previously set.

Expand All @@ -98,19 +98,19 @@ header.SetCategory("marketing") // Reset the categories to be 'marketing' only
<a name="substitution"></a>
## Substitution

Substitutions are a great way of writing short dynamic email content easily,
Substitutions are a great way of writing some short dynamic email content easily,

#### Adding a single substitution string

The `header.AddSubstitution` method can be used to replace content for recipients.
The `header.AddSubstitution` method can be used to replace the content for recipients.

```go
header.AddSubstitution("-name-", "John") // Replace the -name- variable with John.
```

#### Setting substitution strings

The `header.SetSubstitutions` method can be used to replace content for any number of strings.
The `header.SetSubstitutions` method can be used to replace the content for any number of strings.

This method will reset any key pairs that have previously been set.

Expand All @@ -124,15 +124,15 @@ header.SetSubstitutions(map[string][]string{
<a name="sections"></a>
## Sections

Sections are similar to substitutions, but are specific to the actual message rather than the recipient.
Sections that are similar to substitutions, but are specific to the actual message rather than the recipient.

This is useful when you are sending multiple emails with the same style, but different content.
This is useful when you are sending multiple emails with the same style, but with different content.

Note that substitution variables can also be included within a section, but section variables cannot
Note that substitution variables can also be included within a section, but the section variables cannot.

#### Adding a section

The `header.AddSection` method can be used to add a new section to the sections array. This is useful for building up a list of sections dynamically, perhaps based on a user's actions.
The `header.AddSection` method can be used to add a new section to the sections array. This will be useful for building up a list of sections dynamically, perhaps based on a user's actions.

```go
header.AddSection("-event_details-", "The event will be held tomorrow.") // Replaces -event_details- with the event's string
Expand All @@ -142,7 +142,7 @@ header.AddSection("-event_details-", "The event will be held tomorrow.") // Repl

The `header.SetSections` allows you to set multiple sections in a single array.

This is good when sending out multiple emails where no dynamic variation is required.
This is good when sending out multiple emails where there are no dynamic variations required.

This will reset any section key-pairs that have previously been set.

Expand All @@ -160,7 +160,7 @@ Filters allow you to dynamically toggle features such as click tracking, blind c

#### Adding a single filter

Adding a filter is easy with the `header.AddFilter` method.
Adding a filter is easy by using the `header.AddFilter` method.

This method requires 3 values:
- The filter's name
Expand All @@ -174,7 +174,7 @@ header.AddFilter("dkim", "domain", "example.com")

#### Adding pre-existing filters

Filters with predetermined settings can also be added using the `header.SetFilter` method.
Filters with pre-determined settings can also be added using the `header.SetFilter` method.

```go
filter := &Filter{
Expand Down Expand Up @@ -209,7 +209,7 @@ Scheduling the time of your email campaign can be done using a collection of qui

#### Adding a single 'send at' date

The `header.AddSendEachAt` method is a good way to add the time to send at.
The `header.AddSendEachAt` method is a good way to add the time to send the email.

This method requires a unix timestamp as the input.

Expand All @@ -219,7 +219,7 @@ header.AddSendEachAt(1508694645)

#### Setting multiple 'send at' date

The `header.SetSendEachAt` method is useful for setting an array of times that recipients have their emails sent.
The `header.SetSendEachAt` method is a useful method for setting an array of times to which recipients have their emails sent.

This method requires an array of unix timestamps as the input.

Expand All @@ -243,9 +243,9 @@ header.SetSendAt(1508694645)
<a name="batches"></a>
## Batches

Batches are a great way to group a collection of scheduled items for sending. It allows you to cancel scheduled emails, and provides more control over the emails.
Batches are a great way to group a collection of scheduled items for sending. It allows you to cancel the scheduled emails, and provides more control over the emails.

The batch ID can be set using the `header.AddBatchId` method. You must have generated the batch ID first through the API.
The batch ID can be set using the `header.AddBatchId` method. You must have generated the batch ID first with the help of the API.

```go
header.AddBatchId("HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi") // Adds a previously generated batch ID to the emails
Expand All @@ -256,7 +256,7 @@ header.AddBatchId("HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi") // Adds a previously gener

IP Pools allow you to group SendGrid IP addresses together. For example, if you have a set of marketing IPs, you can assign them a pool ID of `marketing`.

The IP Pool name can be set using the `header.SetIpPool` method. You must have generated the IP Pool first through the API.
The IP Pool name can be set using the `header.SetIpPool` method. You must have generated the IP Pool first with the help of the API.

```go
header.SetIpPool("marketing") // Sets the IP Pool to be the marketing collection of IPs
Expand Down

0 comments on commit f766ce2

Please sign in to comment.