Update documentation

Author: mikebronner

CHANGELOG.md

@@ -1,6 +1,60 @@
 # Change Log
 [Package Checklist](http://phppackagechecklist.com/#1,2,3,4,6,7,8,9,10,11,12,13,14)
 
+## [0.6.0] - 31 May 2018
+### Added
+- authorization api functionality.
+
+### Updated
+- changelog and readme.
+
+## [0.5.10] - 22 Mar 2018
+### Fixed
+- various controller and view related items (work in progress).
+
+## [0.5.9] - 22 Mar 2018
+### Fixed
+- policy check in Roles controller.
+
+## [0.5.8] - 16 Mar 2018
+### Fixed
+- service provider class reference in console command.
+
+## [0.5.7] - 7 Mar 2018
+### Fixed
+- permission seeder to respect existing records.
+
+## [0.5.6] - 5 Mar 2018
+### Fixed
+- an edge-case where non-model items were being listened to in listeners.
+
+## [0.5.5] - 10 Feb 2018
+### Fixed
+- service provider class name.
+
+## [0.5.4] - 10 Feb 2018
+### Added
+- Laravel 5.6 compatibility.
+
+## [0.5.3] - 3 Feb 2018
+### Fixed
+- entity management to automatically derive from registered policies.
+
+## [0.5.2] - 3 Feb 2018
+### Fixed
+- role controller authorization.
+
+## [0.5.1] - 20 Nov 2017
+### Updated
+- README with more detailed instructions on initial setup on an empty database.
+
+### Fixed
+- CreatedListener to detect edge-cases where database may not be migrated fully.
+
+## [0.5.0] - 31 Aug 2017
+### Updated
+- to work with Laravel 5.5.
+
 ## [0.4.0] - 4 Jul 2017
 ### Added
 - Laravel 5.4 compatibility.

README.md

@@ -18,7 +18,7 @@ Provide a simple method of managing ACL in a Laravel application built on the
 
 ## Requirements
 - PHP >=7.1.3
-- Laravel >= 5.4
+- Laravel >= 5.5
 - Bootstrap 3 (needs to be included in your layout file)
 - FontAwesome 4 (needs to be included in your layout file)
 
@@ -34,23 +34,14 @@ Install via composer:
 composer require genealabs/laravel-governor
 ```
 
-**ONLY FOR LARVEL 5.4 AND LOWER:** Add the service provider to your app.php config file:
-```php
-'providers' => [
-// [...]
-    GeneaLabs\LaravelGovernor\Providers\Service::class,
-// [...]
-],
-```
-
 ## Implementation
 1. First we need to update the database by running the migrations and data seeders:
     ```sh
     php artisan migrate
     php artisan db:seed --class=LaravelGovernorDatabaseSeeder
     ```
 
-2. If you are starting out with an empty database, run your seeders now:
+2. If you have seeders of your own, run them now:
     ```sh
     php artisan db:seed
     ```
@@ -73,7 +64,8 @@ composer require genealabs/laravel-governor
     class User extends Authenticatable
     {
         use Governable;
-    // [...]
+        // [...]
+    }
     ```
 
 ### Configuration
@@ -142,6 +134,40 @@ We recommend making a custom 403 error page to let the user know they don't have
  https://laravel.com/docs/5.4/errors#custom-http-error-pages for more details on
  how to set those up.
 
+### Authorization API
+You can check a user's ability to perform certain actions via a public API. It
+is recommended to use Laravel Passport to maintain session state between your
+client and your backend. Here's an example that checks if the currently logged
+in user can create `GeneaLabs\LaravelGovernor\Role` model records:
+
+```php
+$response = $this
+    ->json(
+        "GET",
+        route('genealabs.laravel-governor.api.user-can.show', "create"),
+        [
+            "model" => "GeneaLabs\LaravelGovernor\Role",
+        ]
+    );
+```
+
+This next example checks if the user can edit `GeneaLabs\LaravelGovernor\Role`
+model records:
+```php
+$response = $this
+    ->json(
+        "GET",
+        route('genealabs.laravel-governor.api.user-can.show', "edit"),
+        [
+            "model" => "GeneaLabs\LaravelGovernor\Role",
+            "primary-key" => 1,
+        ]
+    );
+```
+
+The abilities `inspect`, `edit`, and `remove`, except `create` and `view`,
+require the primary key to be passed.
+
 ## Examples
 ### Config File
 ```php
@@ -269,3 +295,9 @@ class MyModelPolicy extends LaravelGovernorPolicy
     }
 }
 ```
+
+## Update Process
+### 0.5 to 0.6
+1. If you were extending `GeneaLabs\LaravelGovernor\Policies\LaravelGovernorPolicy`,
+  change to extend `GeneaLabs\LaravelGovernor\Policies\BasePolicy`;
+2. Support for version of Laravel lower than 5.5 has been dropped.