Skip to content

Commit

Permalink
Updated example usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
thinkingserious committed May 31, 2016
1 parent 44930d4 commit 998cb35
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 998cb35

Please sign in to comment.