Merge pull request #523 from yeoji/sampleenv

Added sample env file #520
sendgrid · Oct 29, 2017 · d04707c · d04707c
2 parents 0d860a8 + a323311
commit d04707c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/.env.sample b/.env.sample
@@ -0,0 +1 @@
+export SENDGRID_API_KEY=''
diff --git a/.gitignore b/.gitignore
@@ -2,9 +2,9 @@ test/coverage/*
 dist/
 composer.lock
 vendor
-.env*
+.env
 sendgrid.env
 composer.phar
 .editorconfig
 test.php
-.idea/
+.idea/
diff --git a/README.md b/README.md
@@ -44,10 +44,14 @@ 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 env file to a new file named `.env`
 ```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 `.env` file to include your `SENDGRID_API_KEY`
+3. Source the `.env` file
+```bash
+source ./.env
 ```
 
 ## Install Package