Skip to content
This repository was archived by the owner on Aug 20, 2020. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env_sample
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
SENDGRID_API_KEY='<INSERT YOUR API KEY HERE>';
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# environment variables
.env

# Logs
logs
*.log
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ All updates to this library are documented in our [CHANGELOG](https://github.com

- Node.js version 0.10, 0.12 or 4

You need to have a API key to use the app. To configure the API key in the environment variables follow these steps.
- create .env file in the root directory of the project.
- Copy the contents of .env_sample file in to the .env file
- Once you have obtained the API key, find the environment variable SENDGRID_API_KEY and assign your API key as it's value.
As an example it should look like this
```
SENDGRID_API_KEY='Ef34Gyt&dfPFC34G';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please change this to a placeholder like so:

SENDGRID_API_KEY='<YOUR_API_KEY>';

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed the placeholder as requested with the latest commit

```


## Install Package

```bash
Expand Down
1 change: 1 addition & 0 deletions lib/client.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict'

require('dotenv').config();
var https = require('https')
var http = require('http')
var queryString = require('querystring')
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
"engines": {
"node": ">= 0.10"
},
"dependencies": {},
"dependencies": {
"dotenv": "^4.0.0"
},
"devDependencies": {
"chai": "^3.5.0",
"eslint": "^2.7.0",
Expand Down