Added license and readme

Author: paras-malhotra

LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2018 Insense Private Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,120 @@
+# A Laravel Nova tool for the Spatie Permission library
+
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/insenseanalytics/laravel-nova-permission/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/insenseanalytics/laravel-nova-permission/?branch=master)
+![GitHub](https://img.shields.io/github/license/insenseanalytics/laravel-nova-permission.svg)
+[![Code Intelligence Status](https://scrutinizer-ci.com/g/insenseanalytics/laravel-nova-permission/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
+![Packagist](https://img.shields.io/packagist/dt/insenseanalytics/laravel-nova-permission.svg)
+
+This [Nova](https://nova.laravel.com) tool lets you:
+- manage roles and permissions on the Nova dashboard
+- use permissions based authorization for Nova resources
+
+## Nova Dashboard Screenshots
+
+## Requirements & Dependencies
+There are no PHP dependencies except the Laravel Nova package and the Spatie Permission library.
+
+## Installation
+You can install this tool into a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
+
+```bash
+composer require insenseanalytics/laravel-nova-permission
+```
+
+Next, if you do not have package discovery enabled, you need to register the provider in the `config/app.php` file.
+```php
+'providers' => [
+    ...,
+    Insenseanalytics\LaravelNovaPermission\NovaPermissionServiceProvider::class,
+]
+```
+
+Next, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.
+
+```php
+// in app/Providers/NovaServiceProvider.php
+
+public function tools()
+{
+    return [
+        // ...
+        \Insenseanalytics\LaravelNovaPermission\LaravelNovaPermission::make(),
+    ];
+}
+```
+
+Finally, add `MorphToMany` fields to you `app/Nova/User` resource:
+
+```php
+use Laravel\Nova\Fields\MorphToMany;
+
+public function fields(Request $request)
+{
+    return [
+        // ...
+        MorphToMany::make('Roles', 'roles', \InsenseAnalytics\LaravelNovaPermission\Role::class),
+        MorphToMany::make('Permissions', 'permissions', \InsenseAnalytics\LaravelNovaPermission\Permission::class),
+    ];
+}
+```
+
+## Using Custom Role/Permission Resource Classes
+
+If you want to use custom resource classes you can define them when you register a tool:
+
+```php
+// in app/Providers/NovaServiceProvider.php
+
+public function tools()
+{
+    return [
+        // ...
+        \Insenseanalytics\LaravelNovaPermission\LaravelNovaPermission::make()
+            ->roleResource(CustomRole::class)
+            ->permissionResource(CustomPermission::class),
+    ];
+}
+```
+
+## Permissions Based Authorization for Nova Resources
+By default, Laravel Nova uses Policy based authorization for Nova resources. If you are using the Spatie Permission library, it is very likely that you would want to swap this out to permission based authorization without the need to define Authorization policies.
+
+To do so, you can use the `PermissionsBasedAuthTrait` and define a `permissionsForAbilities` static array property in your Nova resource class like so:
+
+```php
+// in app/Nova/YourNovaResource.php
+
+class YourNovaResource extends Resource
+{
+    use \Insenseanalytics\LaravelNovaPermission\PermissionsBasedAuthTrait;
+
+    public static $permissionsForAbilities = [
+      'all' => 'manage products',
+    ];
+}
+```
+
+The example above means that all actions on this resource can be performed by users who have the "manage products" permission. You can also define separate permissions for each action like so:
+
+```php
+    public static $permissionsForAbilities = [
+      'viewAny' => 'view products',
+      'view' => 'view products',
+      'create' => 'create products',
+      'update' => 'update products',
+      'delete' => 'delete products',
+      'restore' => 'restore products',
+      'forceDelete' => 'forceDelete products',
+      'addAttribute' => 'add product attributes',
+      'attachAttribute' => 'attach product attributes',
+      'detachAttribute' => 'detach product attributes',
+    ];
+```
+
+## Contributing
+
+Contributions are welcome and will be fully credited as long as you use PSR-2, explain the issue/feature that you want to solve/add and back your code up with tests. Happy coding!
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.txt) for more information.

composer.json

@@ -20,7 +20,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "Insenseanalytics\\LaravelNovaPermission\\ToolServiceProvider"
+                "Insenseanalytics\\LaravelNovaPermission\\NovaPermissionServiceProvider"
             ]
         }
     },