Skip to content

Commit 359e14e

Browse files
authored
docs: cleanup README.md anchors and ToC (#826)
1 parent 3542159 commit 359e14e

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-csharp.svg)](https://github.com/sendgrid/sendgrid-csharp/graphs/contributors)
99
[![Open Source Helpers](https://www.codetriage.com/sendgrid/sendgrid-csharp/badges/users.svg)](https://www.codetriage.com/sendgrid/sendgrid-csharp)
1010

11-
# <a name="announcements"></a>Announcements
11+
# Announcements
1212

1313
* Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/csharp) for releases and breaking changes.
1414
* Send SMS messages with [Twilio](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#sms).
@@ -30,17 +30,25 @@ We appreciate your continued support, thank you!
3030
# Table of Contents
3131

3232
* [Installation](#installation)
33+
* [Prerequisites](#prerequisites)
34+
* [Obtain an API Key](#obtain-api)
35+
* [Setup Environment Variables to Manage Your API Key](#setup)
36+
* [Install Package](#install-package)
37+
* [Dependencies](#dependencies)
3338
* [Quick Start](#quick-start)
39+
* [Hello Email](#hello)
40+
* [General v3 Web API Usage](#v3)
41+
* [Web Proxy](#proxy)
3442
* [Usage](#usage)
3543
* [Use Cases](#use-cases)
3644
* [Announcements](#announcements)
3745
* [Roadmap](#roadmap)
38-
* [How to Contribute](#contribute)
46+
* [How to Contribute](#how-to-contribute)
3947
* [Troubleshooting](#troubleshooting)
4048
* [About](#about)
4149
* [License](#license)
4250

43-
# <a name="installation"></a>Installation
51+
# Installation
4452

4553
## Prerequisites
4654

@@ -49,10 +57,12 @@ We appreciate your continued support, thank you!
4957
- .NET Standard 1.3 support
5058
- A Twilio SendGrid account, [sign up for free](https://sendgrid.com/free?source=sendgrid-csharp) to send up to 40,000 emails for the first 30 days, then send 100 emails/day free forever or check out [our pricing](https://sendgrid.com/pricing?source=sendgrid-csharp).
5159

60+
<a name="obtain-api"></a>
5261
## Obtain an API Key
5362

5463
Grab your API Key from the [Twilio SendGrid UI](https://app.sendgrid.com/settings/api_keys).
5564

65+
<a name="setup"></a>
5666
## Setup Environment Variables to Manage Your API Key
5767

5868
Manage your [Twilio SendGrid API Keys](https://app.sendgrid.com/settings/api_keys) by storing them in Environment Variables or in [Web.config](https://docs.microsoft.com/en-us/aspnet/identity/overview/features-api/best-practices-for-deploying-passwords-and-other-sensitive-data-to-aspnet-and-azure). It is a good practice to keep your data and configuration settings separate. This way to you can change your Twilio SendGrid API key without changing your code. Also, we strongly advise against storing sensitive data directly in your code.
@@ -71,7 +81,7 @@ Setup Environment Variables using CMD:
7181
1. Run CMD as administrator
7282
2. setx SENDGRID_API_KEY "YOUR_API_KEY"
7383

74-
Here are few example to get and set API Keys programmatically:
84+
Here are a few examples to get and set API Keys programmatically:
7585

7686
```csharp
7787
# Get Environment Variable
@@ -99,11 +109,12 @@ For sample implementations, see the [.NET Core Example](https://github.com/sendg
99109

100110
Please see the [.csproj file](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGrid.csproj).
101111

102-
# <a name="quick-start"></a>Quick Start
112+
# Quick Start
103113

114+
<a name="hello"></a>
104115
## Hello Email
105116

106-
The following is the minimum needed code to send an simple email. Use this example, and modify the `apiKey`, `from` and `to` variables:
117+
The following is the minimum needed code to send a simple email. Use this example, and modify the `apiKey`, `from` and `to` variables:
107118

108119
```csharp
109120
using System;
@@ -157,8 +168,9 @@ class Program
157168
}
158169
```
159170

160-
You can find an example of all of the email features [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs#L79).
171+
You can find an example of all the email features [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs#L79).
161172

173+
<a name="v3"></a>
162174
## General v3 Web API Usage
163175

164176
```csharp
@@ -179,6 +191,7 @@ class Program
179191
}
180192
```
181193

194+
<a name="proxy"></a>
182195
## Web Proxy
183196

184197
```csharp
@@ -227,7 +240,7 @@ class Program
227240
}
228241
```
229242

230-
# <a name="usage"></a>Usage
243+
# Usage
231244

232245
- [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/api_v3.html)
233246
- [Library Usage Docs](https://github.com/sendgrid/sendgrid-csharp/tree/master/USAGE.md)
@@ -236,15 +249,15 @@ class Program
236249
- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
237250
- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-csharp/tree/master/src/SendGrid/Helpers/Mail)
238251

239-
# <a name="use-cases"></a>Use Cases
252+
# Use Cases
240253

241254
Here are some [examples of common API use cases](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
242255

243-
# <a name="roadmap"></a>Roadmap
256+
# Roadmap
244257

245258
If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-csharp/issues) and [pull requests](https://github.com/sendgrid/sendgrid-csharp/pulls). We would love to hear your feedback!
246259

247-
# <a name="contribute"></a>How to Contribute
260+
# How to Contribute
248261

249262
We encourage contribution to our library (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md) guide for details.
250263

@@ -255,11 +268,11 @@ Quick links:
255268
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#improvements-to-the-codebase)
256269
- [Review Pull Requests](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#code-reviews)
257270

258-
# <a name="troubleshooting"></a>Troubleshooting
271+
# Troubleshooting
259272

260273
Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-csharp/blob/master/TROUBLESHOOTING.md) for common library issues.
261274

262-
# <a name="about"></a>About
275+
# About
263276

264277
sendgrid-csharp is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-csharp are trademarks of Twilio SendGrid, Inc.
265278

0 commit comments

Comments
 (0)