Merge pull request #3 from basakest/document

improve document, fix #2

Author: leeqvip

README.md

@@ -1,16 +1,65 @@
 <h1 align="center">easyswoole-permission</h1>
-<p align="center">An authorization library that supports access control models like ACL, RBAC, ABAC in EasySwoole.</p>
 
-## Installing
+<p align="center">
+    <strong>easyswoole-permission is an authorization library for the easyswoole framework.</strong>    
+</p>
+
+<p align="center">
+    <a href="https://github.com/php-casbin/easyswoole-permission/actions">
+        <img src="https://github.com/php-casbin/easyswoole-permission/workflows/build/badge.svg?branch=master" alt="Build Status">
+    </a>
+    <a href="https://coveralls.io/github/php-casbin/easyswoole-permission">
+        <img src="https://coveralls.io/repos/github/php-casbin/easyswoole-permission/badge.svg" alt="Coverage Status">
+    </a>
+    <a href="https://packagist.org/packages/casbin/easyswoole-permission">
+        <img src="https://poser.pugx.org/casbin/easyswoole-permission/v/stable" alt="Latest Stable Version">
+    </a>
+     <a href="https://packagist.org/packages/casbin/easyswoole-permission">
+        <img src="https://poser.pugx.org/casbin/easyswoole-permission/downloads" alt="Total Downloads">
+    </a>
+    <a href="https://packagist.org/packages/casbin/easyswoole-permissionz">
+        <img src="https://poser.pugx.org/casbin/easyswoole-permission/license" alt="License">
+    </a>
+</p>
+
+[Chinese Version](https://github.com/casbin/easyswoole-permission/blob/master/README_CN.md)
+
+It's based on [Casbin](https://github.com/php-casbin/php-casbin), an authorization library that supports access control models like `ACL`, `RBAC`, `ABAC`.
+
+All you need to learn to use `Casbin` first.
+
+* [Installation](#installation)
+
+* [Usage](#usage)
+
+  - [Database settings](#database-settings)
+  - [Create corresponding data table](#create-corresponding-data-table)
+
+  * [Quick start](#quick-start)
+  * [Using Enforcer Api](#using-enforcer-api)
+
+* [Thinks](#thinks)
+
+* [License](#license)
+
+## Installation
 
 Require this package in the `composer.json` of your easyswoole project. This will download the package.
 
 ```shell
 $ composer require
 ```
 
+Or in the root directory of your easyswoole application, you can use the following composer command to install this package directly .
+
+```shell
+$ composer require casbin/easyswoole-permission:dev-master
+```
+
 ## Usage
 
+### Database settings
+
 add mysql configuration to `dev.php`:
 ```php
 /*################ MYSQL CONFIG ##################*/
@@ -40,6 +89,8 @@ public static function initialize()
 }
 ```
 
+### Create corresponding data table
+
 Before using it, you need to create a table named `casbin_rules` for Casbin to store the policy.
 
 Take mysql as an example:
@@ -60,11 +111,13 @@ CREATE TABLE  if not exists  `casbin_rules` (
 ) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4;
 ```
 
+### Quick start
+
 Then you can start like this:
 
 ```php
-use Easyswolle\Permission\Casbin;
-use Easyswolle\Permission\Config;
+use EasySwoole\Permission\Casbin;
+use EasySwoole\Permission\Config;
 
 $config = new Config();
 $casbin = new Casbin($config);
@@ -92,100 +145,116 @@ if ($casbin->enforce('eve', 'articles', 'edit')) {
 
 It provides a very rich api to facilitate various operations on the Policy:
 
+First create an instance of the enforcer class, and the following operations are based on this instance:
+
+```php
+$config = new Config();
+$casbin = new Casbin($config);
+$enforcer = $casbin->enforcer();
+```
+
 Gets all roles:
 
 ```php
-Enforcer::getAllRoles(); // ['writer', 'reader']
+$enforcer->getAllRoles(); // ['writer', 'reader']
 ```
 
 Gets all the authorization rules in the policy.:
 
 ```php
-Enforcer::getPolicy();
+$enforcer->getPolicy();
 ```
 
 Gets the roles that a user has.
 
 ```php
-Enforcer::getRolesForUser('eve'); // ['writer']
+$enforcer->getRolesForUser('eve'); // ['writer']
 ```
 
 Gets the users that has a role.
 
 ```php
-Enforcer::getUsersForRole('writer'); // ['eve']
+$enforcer->getUsersForRole('writer'); // ['eve']
 ```
 
 Determines whether a user has a role.
 
 ```php
-Enforcer::hasRoleForUser('eve', 'writer'); // true or false
+$enforcer->hasRoleForUser('eve', 'writer'); // true or false
 ```
 
 Adds a role for a user.
 
 ```php
-Enforcer::addRoleForUser('eve', 'writer');
+$enforcer->addRoleForUser('eve', 'writer');
 ```
 
 Adds a permission for a user or role.
 
 ```php
 // to user
-Enforcer::addPermissionForUser('eve', 'articles', 'read');
+$enforcer->addPermissionForUser('eve', 'articles', 'read');
 // to role
-Enforcer::addPermissionForUser('writer', 'articles','edit');
+$enforcer->addPermissionForUser('writer', 'articles','edit');
 ```
 
 Deletes a role for a user.
 
 ```php
-Enforcer::deleteRoleForUser('eve', 'writer');
+$enforcer->deleteRoleForUser('eve', 'writer');
 ```
 
 Deletes all roles for a user.
 
 ```php
-Enforcer::deleteRolesForUser('eve');
+$enforcer->deleteRolesForUser('eve');
 ```
 
 Deletes a role.
 
 ```php
-Enforcer::deleteRole('writer');
+$enforcer->deleteRole('writer');
 ```
 
 Deletes a permission.
 
 ```php
-Enforcer::deletePermission('articles', 'read'); // returns false if the permission does not exist (aka not affected).
+$enforcer->deletePermission('articles', 'read'); // returns false if the permission does not exist (aka not affected).
 ```
 
 Deletes a permission for a user or role.
 
 ```php
-Enforcer::deletePermissionForUser('eve', 'articles', 'read');
+$enforcer->deletePermissionForUser('eve', 'articles', 'read');
 ```
 
 Deletes permissions for a user or role.
 
 ```php
 // to user
-Enforcer::deletePermissionsForUser('eve');
+$enforcer->deletePermissionsForUser('eve');
 // to role
-Enforcer::deletePermissionsForUser('writer');
+$enforcer->deletePermissionsForUser('writer');
 ```
 
 Gets permissions for a user or role.
 
 ```php
-Enforcer::getPermissionsForUser('eve'); // return array
+$enforcer->getPermissionsForUser('eve'); // return array
 ```
 
 Determines whether a user has a permission.
 
 ```php
-Enforcer::hasPermissionForUser('eve', 'articles', 'read');  // true or false
+$enforcer->hasPermissionForUser('eve', 'articles', 'read');  // true or false
 ```
 
 See [Casbin API](https://casbin.org/docs/en/management-api) for more APIs.
+
+## Thinks
+
+[Casbin](https://github.com/php-casbin/php-casbin) in Easyswoole. You can find the full documentation of Casbin [on the website](https://casbin.org/).
+
+## License
+
+This project is licensed under the [Apache 2.0 license](LICENSE).