From d470e524875f2ed7668a37cf0569ac3bc7eb46f2 Mon Sep 17 00:00:00 2001 From: pushkyn Date: Mon, 23 Oct 2017 19:06:19 +0300 Subject: [PATCH] update readme and contributing - fix ToC, add license --- CONTRIBUTING.md | 2 +- README.md | 17 ++++++++++++++--- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b59ca17..72aaf3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -147,7 +147,7 @@ Please run your code through: # Clone your fork of the repo into the current directory git clone https://github.com/sendgrid/php-http-client # Navigate to the newly cloned directory - cd sendgrid-python + cd php-http-client # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/sendgrid/php-http-client ``` diff --git a/README.md b/README.md index 099ec48..ddc4fc5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ +![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png) + [![Travis Badge](https://travis-ci.org/sendgrid/php-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/php-http-client) [![Latest Version on Packagist](https://img.shields.io/packagist/v/sendgrid/php-http-client.svg?style=flat-square)](https://packagist.org/packages/sendgrid/php-http-client) +[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt) +[![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/php-http-client.svg)](https://github.com/sendgrid/php-http-client/graphs/contributors) **Quickly and easily access any RESTful or RESTful-like API.** @@ -13,8 +18,11 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/ - [Installation](#installation) - [Quick Start](#quick-start) - [Usage](#usage) +- [Roadmap](#roadmap) +- [How to Contribute](#contribute) - [Thanks](#thanks) - [About](#about) +- [License](#license) # Installation @@ -128,11 +136,13 @@ print $response->body(); - [Example Code](https://github.com/sendgrid/php-http-client/tree/master/examples) -## Roadmap + +# Roadmap If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/php-http-client/milestones). We would love to hear your feedback. -## How to Contribute + +# How to Contribute We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/php-http-client/blob/master/CONTRIBUTING.md)) guide for details. @@ -155,4 +165,5 @@ php-http-client is guided and supported by the SendGrid [Developer Experience Te php-http-client is maintained and funded by SendGrid, Inc. The names and logos for php-http-client are trademarks of SendGrid, Inc. -![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png) +# License +[The MIT License (MIT)](LICENSE.txt) \ No newline at end of file