summaryrefslogtreecommitdiff
path: root/vendor/lusitanian/oauth/README.md
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-11-06 06:41:47 -0500
committerFrédéric Guillot <fred@kanboard.net>2014-11-06 06:41:47 -0500
commitc80c15dcc33a70acc2b177691d33f088f8c2541e (patch)
treebc3e44e35b97b751c145cc5797a0faf356922244 /vendor/lusitanian/oauth/README.md
parentc91ff61cdfa8b5eb76783927e5b8710f2a9f2601 (diff)
Include all vendor files in the repo to be easier for people
Diffstat (limited to 'vendor/lusitanian/oauth/README.md')
-rw-r--r--vendor/lusitanian/oauth/README.md102
1 files changed, 102 insertions, 0 deletions
diff --git a/vendor/lusitanian/oauth/README.md b/vendor/lusitanian/oauth/README.md
new file mode 100644
index 00000000..e7c2f792
--- /dev/null
+++ b/vendor/lusitanian/oauth/README.md
@@ -0,0 +1,102 @@
+PHPoAuthLib
+===========
+PHPoAuthLib provides oAuth support in PHP 5.3+ and is very easy to integrate with any project which requires an oAuth client.
+
+[![Build Status](https://travis-ci.org/Lusitanian/PHPoAuthLib.png?branch=master)](https://travis-ci.org/Lusitanian/PHPoAuthLib)
+[![Code Coverage](https://scrutinizer-ci.com/g/Lusitanian/PHPoAuthLib/badges/coverage.png?s=a0a15bebfda49e79f9ce289b00c6dfebd18fc98e)](https://scrutinizer-ci.com/g/Lusitanian/PHPoAuthLib/)
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/Lusitanian/PHPoAuthLib/badges/quality-score.png?s=c5976d2fefceb501f0d886c1a5bf087e69b44533)](https://scrutinizer-ci.com/g/Lusitanian/PHPoAuthLib/)
+[![Latest Stable Version](https://poser.pugx.org/lusitanian/oauth/v/stable.png)](https://packagist.org/packages/lusitanian/oauth)
+[![Total Downloads](https://poser.pugx.org/lusitanian/oauth/downloads.png)](https://packagist.org/packages/lusitanian/oauth)
+
+Installation
+------------
+This library can be found on [Packagist](https://packagist.org/packages/lusitanian/oauth).
+The recommended way to install this is through [composer](http://getcomposer.org).
+
+Edit your `composer.json` and add:
+
+```json
+{
+ "require": {
+ "lusitanian/oauth": "~0.3"
+ }
+}
+```
+
+And install dependencies:
+
+```bash
+$ curl -sS https://getcomposer.org/installer | php
+$ php composer.phar install
+```
+
+Features
+--------
+- PSR-0 compliant for easy interoperability
+- Fully extensible in every facet.
+ - You can implement any service with any custom requirements by extending the protocol version's `AbstractService` implementation.
+ - You can use any HTTP client you desire, just create a class utilizing it which implements `OAuth\Common\Http\ClientInterface` (two implementations are included)
+ - You can use any storage mechanism for tokens. By default, session, in-memory and Redis.io (requires PHPRedis) storage mechanisms are included. Implement additional mechanisms by implementing `OAuth\Common\Token\TokenStorageInterface`.
+
+Service support
+---------------
+The library supports both oAuth 1.x and oAuth 2.0 compliant services. A list of currently implemented services can be found below.
+
+Included service implementations
+--------------------------------
+- OAuth1
+ - BitBucket
+ - Etsy
+ - FitBit
+ - Flickr
+ - Scoop.it!
+ - Tumblr
+ - Twitter
+ - Xing
+ - Yahoo
+- OAuth2
+ - Amazon
+ - BitLy
+ - Box
+ - Dailymotion
+ - Dropbox
+ - Facebook
+ - Foursquare
+ - GitHub
+ - Google
+ - Harvest
+ - Heroku
+ - Instagram
+ - LinkedIn
+ - Mailchimp
+ - Microsoft
+ - PayPal
+ - Pocket
+ - Reddit
+ - RunKeeper
+ - SoundCloud
+ - Ustream
+ - Vkontakte
+ - Yammer
+- more to come!
+
+Examples
+--------
+Examples of basic usage are located in the examples/ directory.
+
+Usage
+------
+For usage with complete auth flow, please see the examples. More in-depth documentation will come with release 1.0.
+
+Framework Integration
+---------------------
+* Lithium: Sébastien Charrier has written [an adapter](https://github.com/scharrier/li3_socialauth) for the library.
+* Laravel 4: Dariusz Prząda has written [a service provider](https://github.com/artdarek/oauth-4-laravel) for the library.
+
+Extensions
+----------
+* Extract normalized user data from OAuth Services with the library [PHPoAuthUserData](https://github.com/Oryzone/PHPoAuthUserData) by Luciano Mammino
+
+Tests
+------
+To run the tests, you must install dependencies with `composer install --dev`