Merge pull request #4 from php-api-clients/readme

Fill README with package information

Author: WyriHaximus

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+Pull requests are highly appreciated. Here's a quick guide.
+
+Fork, then clone the repo:
+
+    git clone [email protected]:your-username/psr7-oauth1.git
+
+Set up your machine:
+
+    composer install
+
+Make sure the tests pass:
+
+    make unit
+
+Make your change. Add tests for your change. Make the tests pass:
+
+    make unit
+    
+Before committing and submitting your pull request make sure it passes PSR2 coding style, unit tests pass and pass on all supported PHP versions:
+
+    make contrib
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://help.github.com/articles/creating-a-pull-request/
+
+At this point you're waiting on me. I like to at least comment on pull requests
+within a day or two. I may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Follow PSR2 (travis will also check for this).
+* Write a [good commit message][commit].
+
+[commit]: http://chris.beams.io/posts/git-commit/

README.md

@@ -1,4 +1,4 @@
-# API Client PSR-7 Oauth1
+# Client-side PSR-7 Oauth1 request signer
 
 [![Build Status](https://travis-ci.org/php-api-clients/psr7-oauth1.svg?branch=master)](https://travis-ci.org/php-api-clients/psr7-oauth1)
 [![Latest Stable Version](https://poser.pugx.org/api-clients/psr7-oauth1/v/stable.png)](https://packagist.org/packages/api-clients/psr7-oauth1)
@@ -7,6 +7,44 @@
 [![License](https://poser.pugx.org/api-clients/psr7-oauth1/license.png)](https://packagist.org/packages/api-clients/psr7-oauth1)
 [![PHP 7 ready](http://php7ready.timesplinter.ch/php-api-clients/psr7-oauth1/badge.svg)](https://appveyor-ci.org/php-api-clients/psr7-oauth1)
 
+# Installation
+
+To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.
+
+```bash
+composer require api-clients/psr7-oauth1 
+```
+
+# Example
+
+```php
+<?php
+
+use ApiClients\Tools\Psr7\Oauth1\Definition;
+use ApiClients\Tools\Psr7\Oauth1\RequestSigning\RequestSigner;
+use ApiClients\Tools\Psr7\Oauth1\Signature\HmacSha1Signature;
+
+$consumerSecret = new Definition\ConsumerSecret('consumer_secret');
+
+$requestSigner = new RequestSigner(
+    new Definition\ConsumerKey('consumer_key'),
+    $consumerSecret,
+    new HmacSha1Signature( // Optional, but allows for other than HMAC SHA1 signatures
+        $consumerSecret  
+    )
+);
+
+// Pass it a PSR-7 request and it returns a signed PSR7 request you can use in any PSR7 capable HTTP client.
+$request = $requestSigner->withAccessToken(
+    new Definition\AccessToken('token_key'),
+    new Definition\TokenSecret('token_secret')
+)->sign($request);
+```
+
+# Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
 # License
 
 The MIT License (MIT)