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.

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

Jump to bottom

docs: update CONTRIBUTING.md with environment variables section #62

Merged
merged 1 commit into from
Jan 17, 2020
Merged

docs: update CONTRIBUTING.md with environment variables section #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,11 @@ git clone https://github.com/sendgrid/rest.git
cd rest
```

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

See the [examples folder](https://github.com/sendgrid/rest/tree/master/examples) to get started quickly.

If you want to try the SendGrid example:
### Environment Variables

First, get your free SendGrid account [here](https://sendgrid.com/free?source=rest).

You will need to setup the following environment to use the SendGrid example:
Next, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) if you will test with Swift Mailer.

```
echo "export SENDGRID-API-KEY='YOUR-API-KEY'" > sendgrid.env
Expand All @@ -90,6 +86,10 @@ source ./sendgrid.env
go run examples/example.go
```

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

See the [examples folder](https://github.com/sendgrid/rest/tree/master/examples) to get started quickly.

<a name="understanding-the-codebase"></a>
## Understanding the Code Base

Expand Down