diff --git a/.env_sample b/.env_sample new file mode 100644 index 0000000..30857f4 --- /dev/null +++ b/.env_sample @@ -0,0 +1 @@ +export SENDGRID_API_KEY='' \ No newline at end of file diff --git a/README.md b/README.md index 18ba291..d356deb 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,18 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/ - Ruby version 2.2+ +## 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 +``` + ## Install Package ```bash @@ -98,4 +110,4 @@ ruby-http-client is guided and supported by the SendGrid [Developer Experience T ruby-http-client is maintained and funded by SendGrid, Inc. The names and logos for ruby-http-client are trademarks of SendGrid, Inc. # License -[The MIT License (MIT)](LICENSE.txt) \ No newline at end of file +[The MIT License (MIT)](LICENSE.txt)