Skip to content

Commit

Permalink
Merge pull request #319 from thiagobbt/master
Browse files Browse the repository at this point in the history
Add .env_sample file
  • Loading branch information
Matt Bernier authored Oct 31, 2017
2 parents a7f9823 + f9b4ac4 commit 62e1137
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions .env_sample
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export SENDGRID_API_KEY=''
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ target
examples/Example.java
.settings
.classpath
.project
.project
.env
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,16 @@ We appreciate your continued support, thank you!

Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:

1. Copy the sample environment file to a new file
```bash
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
cp .env_sample .env
```
2. Edit the new `.env` to add your API key
3. Source the `.env` file to set rhe variable in the current session
```bash
source .env
```

## Install Package

Choose your installation method - Maven w/ Gradle (recommended), Maven or Jar file.
Expand Down Expand Up @@ -229,4 +234,4 @@ sendgrid-java is guided and supported by the SendGrid [Developer Experience Team
sendgrid-java is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-java are trademarks of SendGrid, Inc.

# License
[The MIT License (MIT)](LICENSE.txt)
[The MIT License (MIT)](LICENSE.txt)

0 comments on commit 62e1137

Please sign in to comment.