Skip to content

Commit eacbf64

Browse files
committed
Update readme - moved logo to top, added ToC, license and more badges
1 parent b67ac3d commit eacbf64

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
1+
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
2+
13
[![Travis Badge](https://travis-ci.org/sendgrid/csharp-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/csharp-http-client)
4+
[![NuGet](https://img.shields.io/nuget/v/SendGrid.CSharp.Http.Client.svg)](https://www.nuget.org/packages/SendGrid.CSharp.HTTP.Client)
5+
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
6+
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
7+
[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/csharp-http-client.svg)](https://github.com/sendgrid/csharp-http-client/graphs/contributors)
28

39
**Quickly and easily access any RESTful or RESTful-like API.**
410

511
If you are looking for the SendGrid API client library, please see [this repo](https://github.com/sendgrid/sendgrid-csharp).
612

13+
# Table of Contents
14+
15+
* [Announcements](#announcements)
16+
* [Installation](#installation)
17+
* [Quick Start](#quick-start)
18+
* [Usage](#usage)
19+
* [Roadmap](#roadmap)
20+
* [How to Contribute](#contribute)
21+
* [Thanks](#thanks)
22+
* [About](#about)
23+
* [License](#license)
24+
25+
<a name="announcements"></a>
726
# Announcements
827

928
All updates to this project is documented in our [CHANGELOG](https://github.com/sendgrid/csharp-http-client/blob/master/CHANGELOG.md).
1029

30+
<a name="installation"></a>
1131
# Installation
1232

1333
## Prerequisites
@@ -30,6 +50,7 @@ Add the following namespace to use the library:
3050
using SendGrid.CSharp.HTTP.Client;
3151
```
3252

53+
<a name="quick-start"></a>
3354
# Quick Start
3455

3556
Here is a quick example:
@@ -65,15 +86,18 @@ Console.WriteLine(response.Body.ReadAsStringAsync().Result);
6586
Console.WriteLine(response.Headers.ToString());
6687
```
6788

89+
<a name="usage"></a>
6890
# Usage
6991

7092
- [Example Code](https://github.com/sendgrid/csharp-http-client/blob/master/Example/Example.cs)
7193

72-
## Roadmap
94+
<a name="roadmap"></a>
95+
# Roadmap
7396

7497
If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/csharp-http-client/milestones). We would love to hear your feedback.
7598

76-
## How to Contribute
99+
<a name="contribute"></a>
100+
# How to Contribute
77101

78102
We encourage contribution to our projects, please see our [CONTRIBUTING](https://github.com/sendgrid/csharp-http-client/blob/master/CONTRIBUTING.md) guide for details.
79103

@@ -84,15 +108,17 @@ Quick links:
84108
- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/csharp-http-client/blob/master/CONTRIBUTING.md#cla)
85109
- [Improvements to the Codebase](https://github.com/sendgrid/csharp-http-client/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
86110

111+
<a name="thanks"></a>
87112
# Thanks
88113

89114
We were inspired by the work done on [birdy](https://github.com/inueni/birdy) and [universalclient](https://github.com/dgreisen/universalclient).
90115

116+
<a name="about"></a>
91117
# About
92118

93119
csharp-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:[email protected]).
94120

95121
csharp-http-client is maintained and funded by SendGrid, Inc. The names and logos for csharp-http-client are trademarks of SendGrid, Inc.
96122

97-
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
98-
123+
# License
124+
[The MIT License (MIT)](LICENSE.txt)

0 commit comments

Comments
 (0)