Skip to content

Commit b9ddb85

Browse files
committed
Add .env_sample file
1 parent c5df9b8 commit b9ddb85

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

Diff for: .env_sample

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export SENDGRID_API_KEY=''

Diff for: .gitignore

+2-1
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

Diff for: README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,13 @@ 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+
5254
## Install Package
5355

5456
Choose your installation method - Maven w/ Gradle (recommended), Maven or Jar file.

0 commit comments

Comments
 (0)