Skip to content

Commit 0ea26df

Browse files
committed
Update readme - moved logo to top, added ToC, license and other badges
1 parent 6685bbb commit 0ea26df

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
1-
[![Build Status](https://travis-ci.org/sendgrid/java-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/java-http-client) [![Maven](https://maven-badges.herokuapp.com/maven-central/com.sendgrid/java-http-client/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.sendgrid/java-http-client)
1+
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
2+
3+
[![Build Status](https://travis-ci.org/sendgrid/java-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/java-http-client)
4+
[![Maven](https://maven-badges.herokuapp.com/maven-central/com.sendgrid/java-http-client/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.sendgrid/java-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/java-http-client.svg)](https://github.com/sendgrid/java-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-java).
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+
* [About](#about)
22+
* [License](#license)
23+
24+
<a name="announcements"></a>
725
# Announcements
826

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

29+
<a name="installation"></a>
1130
# Installation
1231

1332
## Prerequisites
@@ -49,6 +68,7 @@ repositories {
4968

5069
- Please see the [build.gradle file](https://github.com/sendgrid/java-http-client/blob/master/build.gradle)
5170

71+
<a name="quick-start"></a>
5272
# Quick Start
5373

5474
Here is a quick example:
@@ -95,6 +115,7 @@ try {
95115
}
96116
```
97117

118+
<a name="usage"></a>
98119
# Usage
99120

100121
- [Example Code](https://github.com/sendgrid/java-http-client/tree/master/examples)
@@ -115,11 +136,13 @@ cd examples
115136
javac -classpath {path_to}/sendgrid-java-http-client-4.0.0-jar.jar:. Example.java && java -classpath {path_to}/sendgrid-java-http-client-4.0.0-jar.jar:. Example
116137
```
117138

118-
## Roadmap
139+
<a name="roadmap"></a>
140+
# Roadmap
119141

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

122-
## How to Contribute
144+
<a name="contribute"></a>
145+
# How to Contribute
123146

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

@@ -130,10 +153,12 @@ Quick links:
130153
- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/java-http-client/blob/master/CONTRIBUTING.md#cla)
131154
- [Improvements to the Codebase](https://github.com/sendgrid/java-http-client/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
132155

156+
<a name="about"></a>
133157
# About
134158

135159
java-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
136160

137161
java-http-client is maintained and funded by SendGrid, Inc. The names and logos for java-http-client are trademarks of SendGrid, Inc.
138162

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

0 commit comments

Comments
 (0)