diff options
| -rw-r--r-- | CONTRIBUTING.md | 12 | ||||
| -rw-r--r-- | README.md | 12 |
2 files changed, 21 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afb10c7..60774e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,10 +91,18 @@ node examples/example.js See the [examples folder](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples) to get started quickly. -To run the example: +To run an example: ```bash -node examples/example.js +touch test.js +``` + +Copy the desired example into `test.js`. + +Change the path to the Sendgrid library to `./lib/sendgrid.js`. + +``` +node test.js ``` <a name="understanding_the_codebase"></a> @@ -20,6 +20,7 @@ have the following resources to get you started quickly: - [SendGrid Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) +- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/USAGE.md) - [Example Code](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples) @@ -65,7 +66,15 @@ git clone -b v3beta --single-branch https://github.com/sendgrid/sendgrid-nodejs. * Review the corresponding [examples](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/examples). ```bash -$ node examples/example.js +touch test.js +``` + +Copy the desired example into `test.js`. + +Change the path to the Sendgrid library to `./lib/sendgrid.js`. + +``` +node test.js ``` * Check out the documentation for [Web API v3 /mail/send/beta endpoint](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html). @@ -153,6 +162,7 @@ sg.API(requestGet, function (response) { # Usage - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) +- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/USAGE.md) - [Example Code](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples) - [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/lib/helpers/mail/README.md |