Skip to content

Commit fc82915

Browse files
committed
update readme - add license, remove logo from bottom, add ToC
1 parent 70578aa commit fc82915

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
22

3-
[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)[![npm](https://img.shields.io/npm/l/express.svg)]()[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/ruby-http-client.svg)](https://github.com/sendgrid/ruby-http-client/graphs/contributors)
3+
[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)
4+
[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
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/ruby-http-client.svg)](https://github.com/sendgrid/ruby-http-client/graphs/contributors)
48

59
**Quickly and easily access any RESTful or RESTful-like API.**
610

@@ -10,6 +14,16 @@ If you are looking for the SendGrid API client library, please see [this repo](h
1014

1115
All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md).
1216

17+
# Table of Contents
18+
- [Installation](#installation)
19+
- [Quick Start](#quick-start)
20+
- [Usage](#usage)
21+
- [Roadmap](#roadmap)
22+
- [How to Contribute](#contribute)
23+
- [About](#about)
24+
- [License](#license)
25+
26+
<a name="installation"></a>
1327
# Installation
1428

1529
## Prerequisites
@@ -22,6 +36,7 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
2236
gem install ruby_http_client
2337
```
2438

39+
<a name="quick-start"></a>
2540
# Quick Start
2641

2742
`GET /your/api/{param}/call`
@@ -53,15 +68,18 @@ puts response.body
5368
puts response.headers
5469
```
5570

71+
<a name="usage"></a>
5672
# Usage
5773

5874
- [Example Code](https://github.com/sendgrid/ruby-http-client/tree/master/examples)
5975

60-
## Roadmap
76+
<a name="roadmap"></a>
77+
# Roadmap
6178

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

64-
## How to Contribute
81+
<a name="contribute"></a>
82+
# How to Contribute
6583

6684
We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md) guide for details.
6785

@@ -72,11 +90,12 @@ Quick links:
7290
- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md)
7391
- [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
7492

75-
93+
<a name="about"></a>
7694
# About
7795

7896
ruby-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:[email protected]).
7997

8098
ruby-http-client is maintained and funded by SendGrid, Inc. The names and logos for ruby-http-client are trademarks of SendGrid, Inc.
8199

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

0 commit comments

Comments
 (0)