Add a .env_sample file, update gitignore, update README.md

sendgrid · Oct 27, 2017 · 9bd0b7f · 9bd0b7f · techonomics69 · Sep 21, 2018
1 parent 003a205
commit 9bd0b7f
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/.env_sample b/.env_sample
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .DS_Store
 temp.go
 *.swp
+.env
diff --git a/README.md b/README.md
@@ -60,6 +60,24 @@ source ./sendgrid.env
 
 - [rest](https://github.com/sendgrid/rest)
 
+## Setup Environment Variables
+
+### Initial Setup
+
+```bash
+cp .env_sample .env
+```
+
+### 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