Merge pull request #26 from thepriefy/priefy-issue-20-1

Add a .env_sample file
sendgrid · Oct 30, 2017 · dcffa84 · dcffa84
2 parents 125dcff + 5d1f704
commit dcffa84
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/.env_sample b/.env_sample
@@ -0,0 +1 @@
+SENDGRID_API_KEY=
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.env
diff --git a/README.md b/README.md
@@ -52,6 +52,18 @@ Or install it yourself as:
 gem install smtpapi
 ```
 
+## Setup Environment Variables
+
+### Environment Variable
+
+Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:
+
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
+```
+
 <a name="quick-start"></a>
 # Quick Start
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,3 +15,4 @@ spec/reports @@
     test/tmp
     test/version_tmp
     tmp
+    .env