diff --git a/README.md b/README.md index 109279c8..96e8ddfb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# PHP OAuth Framework +# The League of Extraordinary Packages presents: PHP OAuth 2.0 Server -The goal of this project is to develop a standards compliant [OAuth 2](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authorization server and resource server. +The goal of this project is to develop a standards compliant [OAuth 2.0](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authorization server and resource server. ## Package Installation @@ -9,20 +9,20 @@ The framework is provided as a Composer package which can be installed by adding ```javascript { "require": { - "league/oauth2server": "2.*" + "league/oauth2-server": "2.*" } } ``` --- -The library features 100% unit test code coverage. To run the tests yourself run `phpunit -c build/phpunit.xml`. +The library features 100% unit test code coverage. To run the tests yourself run `phpunit` from the project root. ## Current Features ### Authorization Server -The authorization server is a flexible class and following core specification grants are implemented: +The authorization server is a flexible class and the following core specification grants are implemented: * authorization code ([section 4.1](http://tools.ietf.org/html/rfc6749#section-4.1)) * refresh token ([section 6](http://tools.ietf.org/html/rfc6749#section-6)) @@ -33,8 +33,15 @@ An overview of the different OAuth 2.0 grants can be found at [http://alexbilbie ### Resource Server -The resource server allows you to secure your API endpoints by checking for a valid OAuth access token in the request and ensuring the token has the correct permission to access resources. +The resource server allows you to secure your API endpoints by checking for a valid OAuth access token in the request and ensuring the token has the correct scope(s) (i.e. permissions) to access resources. +### Custom grants + +Custom grants can be created easily by implementing an interface. Check out a guide here [https://github.com/php-loep/oauth2-server/wiki/Creating-custom-grants](https://github.com/php-loep/oauth2-server/wiki/Creating-custom-grants). + +### PDO driver + +If you are using MySQL and want to very quickly implement the library then all of the storage interfaces have been implemented with PDO classes. Check out the guide here [https://github.com/php-loep/oauth2-server/wiki/Using-the-PDO-storage-classes](https://github.com/php-loep/oauth2-server/wiki/Using-the-PDO-storage-classes). ## Tutorials @@ -53,6 +60,6 @@ A tutorial on how to use the resource server to secure an API server can be foun The initial code was developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which was funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme. -This code is principally developed by [Alex Bilbie](http://alexbilbie.com/) ([Twitter](https://twitter.com/alexbilbie)|[Github](https://github.com/alexbilbie)). +This code is principally developed and maintained by [@alexbilbie](https://twitter.com/alexbilbie). A list of contributors can be found at [https://github.com/php-loep/oauth2-server/contributors](https://github.com/php-loep/oauth2-server/contributors). \ No newline at end of file