Skip to content

Commit 191ed38

Browse files
author
Matt Bernier
authored
Merge branch 'master' into master
2 parents eb29633 + e712c17 commit 191ed38

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs)
66
[![npm](https://img.shields.io/npm/l/express.svg)]()
77
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
8+
[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-nodejs.svg)](https://github.com/sendgrid/sendgrid-nodejs/graphs/contributors)
89

910
**This library allows you to quickly and easily use the SendGrid Web API v3 via Node.js.**
1011

@@ -26,9 +27,9 @@ We appreciate your continued support, thank you!
2627
* [About](#about)
2728

2829
<a name="introduction"></a>
29-
# Introduction
30+
# Introduction - Please Read First
3031

31-
This library is broken up into several packages as a monorepo so that you only need to install the packages necessary for your use case. This README contains information pertaining to all packages.
32+
This library is broken up into several packages as a monorepo so that you only need to install the packages necessary for your use case. This README contains information pertaining to all packages. For examples on how to get started quickly, head over to the READMEs of each individual package (linked and described below), which includes detailed examples.
3233

3334
* [@sendgrid/mail](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/mail) - if you just want to send email
3435
* [@sendgrid/client](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/client) - to use all other [SendGrid v3 Web API endpoints](https://sendgrid.com/docs/API_Reference/api_v3.html)

packages/mail/USE_CASES.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ This documentation provides examples for specific email use cases. Please [open
1616
* [Specifying Custom Headers](#customheaders)
1717
* [Specifying Categories](#categories)
1818
* [Kitchen Sink - an example with all settings used](#kitchensink)
19+
* [How to Setup a Domain Whitelabel](#domain_whitelabel)
20+
* [How to View Email Statistics](#email_stats)
1921

2022
<a name="singleemailsinglerecipient"></a>
2123
# Send a Single Email to a Single Recipient
@@ -456,3 +458,17 @@ sgMail
456458
.then(() => console.log('Mail sent successfully'))
457459
.catch(error => console.error(error.toString()));
458460
```
461+
462+
<a name="domain_whitelabel"></a>
463+
# How to Setup a Domain Whitelabel
464+
465+
You can find documentation for how to setup a domain whitelabel via the UI [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/setup_domain_whitelabel.html) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#whitelabel).
466+
467+
Find more information about all of SendGrid's whitelabeling related documentation [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/index.html).
468+
469+
<a name="email_stats"></a>
470+
# How to View Email Statistics
471+
472+
You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#stats).
473+
474+
Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as SendGrid processes your email.

0 commit comments

Comments
 (0)