(finally!) review readme.md getting started #523
Conversation
- made small phrasing changes - updated API docs link
thinkingserious
added
the
status: code review request
|
|
README.md
Outdated
|
|
||
| ## Setup Environment Variables | ||
|
|
||
| Update the development Environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys). For example, in Windows 10, please review [this thread](http://superuser.com/questions/949560/how-do-i-set-system-environment-variables-in-windows-10). | ||
| Set your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) environment variable in your development environment. For example,[this thread](http://superuser.com/questions/949560/how-do-i-set-system-environment-variables-in-windows-10) explains how to set an environment variable in a Windows 10 system. |
There was a problem hiding this comment.
I think this could be a little more clear still - when you set an environment variable, don't you have to name the variable? Or are we saying that you should add your API key to your PATH? Either way, I think we could make it a bit more clear.
There was a problem hiding this comment.
How about:
We advise against hard coding your SENDGRID_API_KEY in your application. Instead, please use an environment variable or Web.config or similar.
|
Line 65 is: "Once you have the SendGrid libraries properly referenced in your project, you can include calls..." What do they have to do to reference them in their project? |
apigirl
changed the title
README.md
Outdated
|
|
||
| ## Setup Environment Variables | ||
|
|
||
| Update the development Environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys). For example, in Windows 10, please review [this thread](http://superuser.com/questions/949560/how-do-i-set-system-environment-variables-in-windows-10). | ||
| Set your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) environment variable in your development environment. For example,[this thread](http://superuser.com/questions/949560/how-do-i-set-system-environment-variables-in-windows-10) explains how to set an environment variable in a Windows 10 system. |
There was a problem hiding this comment.
How about:
We advise against hard coding your SENDGRID_API_KEY in your application. Instead, please use an environment variable or Web.config or similar.
|
@thinkingserious okay, I updated the Environment Variables section. Thanks for your suggestion! Any thoughts on my other comment? |
|
"Once you have the SendGrid libraries properly referenced in your project, you can include calls..." could be "Once you have the SendGrid libraries properly installed in your project, you can include calls..." |
|
Is there anything that users have to do to install and reference the project other than what's in the Install Package section? |
|
No |
|
okay, cool! that makes more sense then. I updated it - let me know if my update is accurate! Other than that, I didn't have anything else! |
Also, see my comment for two sections that I think could use clarification.