Skip to content

Commit

Permalink
Create use-cases directory
Browse files Browse the repository at this point in the history
Move each separate use case into their own separate files, linked from
the `use-cases` directory.

Closes #401.
  • Loading branch information
jamietanna committed Oct 31, 2017
1 parent 62e1137 commit ac1b457
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 24 deletions.
9 changes: 9 additions & 0 deletions use-cases/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Use Cases

This directory provides examples for specific use cases.

Please [open an issue](https://github.com/sendgrid/sendgrid-java/issues/new) or make a pull request for any use cases you would like us to document here. Thank you!

* [Transactional Templates](transactional_templates.md)
* [How to Setup a Domain Whitelabel](domain_whitelabel.md)
* [How to View Email Statistics](email_statistics.md)
5 changes: 5 additions & 0 deletions use-cases/domain-whitelabel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# How to Setup a Domain Whitelabel

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-java/blob/master/USAGE.md#whitelabel).

Find more information about all of SendGrid's whitelabeling related documentation [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/index.html).
5 changes: 5 additions & 0 deletions use-cases/email-statistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# How to View Email Statistics

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-java/blob/master/USAGE.md#stats).

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.
24 changes: 0 additions & 24 deletions USE_CASES.md → use-cases/transactional-templates.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
This documentation provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/sendgrid-java/issues) or make a pull request for any use cases you would like us to document here. Thank you!

# Table of Contents

* [Transactional Templates](#transactional_templates)
* [How to Setup a Domain Whitelabel](#domain_whitelabel)
* [How to View Email Statistics](#email_stats)

<a name="transactional-templates"></a>
# Transactional Templates

For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
Expand Down Expand Up @@ -101,18 +92,3 @@ public class Example {
}
}
```

<a name="domain_whitelabel"></a>
# How to Setup a Domain Whitelabel

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-java/blob/master/USAGE.md#whitelabel).

Find more information about all of SendGrid's whitelabeling related documentation [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/index.html).

<a name="email_stats"></a>
# How to View Email Statistics

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-java/blob/master/USAGE.md#stats).

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 comments on commit ac1b457

Please sign in to comment.