Skip to content

Commit 62e1137

Browse files
author
Matt Bernier
authored
Merge pull request sendgrid#319 from thiagobbt/master
Add .env_sample file
2 parents a7f9823 + f9b4ac4 commit 62e1137

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

.env_sample

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export SENDGRID_API_KEY=''

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ target
1212
examples/Example.java
1313
.settings
1414
.classpath
15-
.project
15+
.project
16+
.env

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,16 @@ We appreciate your continued support, thank you!
4444

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

47+
1. Copy the sample environment file to a new file
4748
```bash
48-
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
49-
echo "sendgrid.env" >> .gitignore
50-
source ./sendgrid.env
49+
cp .env_sample .env
5150
```
51+
2. Edit the new `.env` to add your API key
52+
3. Source the `.env` file to set rhe variable in the current session
53+
```bash
54+
source .env
55+
```
56+
5257
## Install Package
5358

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

231236
# License
232-
[The MIT License (MIT)](LICENSE.txt)
237+
[The MIT License (MIT)](LICENSE.txt)

0 commit comments

Comments
 (0)