From 3661fa7ef7030c689a2ea54d39b5bfa2ca83680d Mon Sep 17 00:00:00 2001 From: Wong Hoi Sing Edison Date: Mon, 6 Jul 2015 14:39:38 +0800 Subject: [PATCH] Cleanup some docs. --- README.md | 4 ++-- .../Resources/views/index.html.twig | 22 +++++++++---------- .../Resources/views/page_bottom.html.twig | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e1e9a90b..379bd7b4 100644 --- a/README.md +++ b/README.md @@ -71,8 +71,8 @@ Moreover, we also provide following model [CRUD](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete) controller for alter raw data set: -- `authbucket_oauth2.authorize_controller`: Authorize endpoint - controller. +- `authbucket_oauth2.authorize_controller`: Authorize + endpoint controller. - `authbucket_oauth2.client_controller`: Client endpoint controller. - `authbucket_oauth2.scope_controller`: Scope endpoint controller. diff --git a/tests/TestBundle/Resources/views/index.html.twig b/tests/TestBundle/Resources/views/index.html.twig index 557657a1..e83281a8 100644 --- a/tests/TestBundle/Resources/views/index.html.twig +++ b/tests/TestBundle/Resources/views/index.html.twig @@ -19,19 +19,19 @@ License

The primary goal of AuthBucket\OAuth2 is to develop a standards compliant RFC6749 OAuth2.0 library; secondary goal would be develop corresponding wrapper Symfony2 Bundle and Drupal module.

-

This library bundle with a Silex based AuthBucketOAuth2ServiceProvider for unit test and demo purpose. Installation and usage can refer as below.

+

This library bundle with a Silex based AuthBucketOAuth2ServiceProvider for unit test and demo purpose. Installation and usage can refer as below.

Installation

Simply add a dependency on authbucket/oauth2-php to your project's composer.json file if you use Composer to manage the dependencies of your project.

Here is a minimal example of a composer.json:

{
     "require": {
-        "authbucket/oauth2-php": "~2.4"
+        "authbucket/oauth2-php": "~3.0"
     }
 }

Parameters

-

The bundled AuthBucketOAuth2ServiceProvider come with following parameters:

+

The bundled AuthBucketOAuth2ServiceProvider come with following parameters:

Services

-

The bundled AuthBucketOAuth2ServiceProvider come with following services controller which simplify the OAuth2.0 controller implementation overhead:

+

The bundled AuthBucketOAuth2ServiceProvider come with following services controller which simplify the OAuth2.0 controller implementation overhead:

@@ -51,7 +51,7 @@

Registering

-

If you are using Silex, register AuthBucketOAuth2ServiceProvider as below:

+

If you are using Silex, register AuthBucketOAuth2ServiceProvider as below:

$app->register(new AuthBucket\OAuth2\Provider\AuthBucketOAuth2ServiceProvider());

Moreover, enable following service providers if that's not already the case:

$app->register(new Silex\Provider\SecurityServiceProvider());
@@ -139,12 +139,12 @@ $app['security.firewalls'] = array(
 );

Demo

-

The demo is based on Silex and AuthBucketOAuth2ServiceProvider. Read though Demo for more information.

+

The demo is based on Silex and AuthBucketOAuth2ServiceProvider. Read though Demo for more information.

You may also run the demo locally. Open a console and execute the following command to install the latest version in the oauth2-php directory:

-
$ composer create-project authbucket/oauth2-php oauth2-php "~2.4"
+
$ composer create-project authbucket/oauth2-php oauth2-php "~3.0"

Then use the PHP built-in web server to run the demo application:

$ cd oauth2-php
-$ php app/console server:run
+$ ./app/console server:run

If you get the error There are no commands defined in the "server" namespace., then you are probably using PHP 5.3. That's ok! But the built-in web server is only available for PHP 5.4.0 or higher. If you have an older version of PHP or if you prefer a traditional web server such as Apache or Nginx, read the Configuring a web server article.

Open your browser and access the http://127.0.0.1:8000 URL to see the Welcome page of demo application.

Also access http://127.0.0.1:8000/admin/refresh_database to initialize the bundled SQLite database with user account admin:secrete.

@@ -152,13 +152,13 @@ $ php app/console server:run

Documentation

OAuth2's documentation is built with Sami and publicly hosted on GitHub Pages.

To built the documents locally, execute the following command:

-
$ vendor/bin/sami.php update .sami.php
+
$ composer sami

Open build/sami/index.html with your browser for the documents.

Tests

This project is coverage with PHPUnit test cases; CI result can be found from Travis CI; code coverage report can be found from Coveralls.

To run the test suite locally, execute the following command:

-
$ vendor/bin/phpunit
+
$ composer phpunit

Open build/logs/html with your browser for the coverage report.

References

@@ -175,7 +175,7 @@ $ php app/console server:run

License

diff --git a/tests/TestBundle/Resources/views/page_bottom.html.twig b/tests/TestBundle/Resources/views/page_bottom.html.twig index 0270b4a7..d36b3c3e 100644 --- a/tests/TestBundle/Resources/views/page_bottom.html.twig +++ b/tests/TestBundle/Resources/views/page_bottom.html.twig @@ -7,7 +7,7 @@

    • Design and built with all the love in the world by @hswong3i.

    -

    Code released under MIT. Docs released under CC BY-NC-SA 3.0.

    +

    Code released under MIT. Docs released under CC BY 4.0.