Version 0.5.4

[userbundle] / README.md

diff --git a/README.md b/README.md
index 7867c59e955f25565dd1f633cbe8f9ec0a12c277..c33583a1a9de2dcea0c70d7506e02a688459bf43 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
+Contribute
+==========
+
+You may buy me a Beer, a Tea or help with Server fees with a paypal donation to
+the address <paypal@rapsys.eu>.
+
+Don't forget to show your love for this project, feel free to report bugs to
+the author, issues which are security relevant should be disclosed privately
+first.
+
+Patches are welcomed and grant credit when requested.
+
 Installation
 ============
 
@@ -8,36 +20,36 @@ Add bundle custom repository to your project's `composer.json` file:
 
 ```json
 {
-    ...,
-    "repositories": [
-        {
-            "type": "package",
-            "package": {
-                "name": "rapsys/userbundle",
-                "version": "dev-master",
-                "source": {
-                    "type": "git",
-                    "url": "https://git.rapsys.eu/userbundle",
-                    "reference": "master"
-                },
-                "autoload": {
-                    "psr-4": {
-                        "Rapsys\\UserBundle\\": ""
-                    }
-                },
-                "require": {
-                    "doctrine/doctrine-bundle": "^1.12",
-                    "rapsys/packbundle": "dev-master",
-                    "symfony/flex": "^1.5",
-                    "symfony/form": "^4.4",
-                    "symfony/framework-bundle": "^4.4",
-                    "symfony/security-bundle": "^4.4",
-                    "symfony/validator": "^4.4"
-                }
-            }
-        }
-    ],
-    ...
+       ...,
+       "repositories": [
+               {
+                       "type": "package",
+                       "package": {
+                               "name": "rapsys/userbundle",
+                               "version": "dev-master",
+                               "source": {
+                                       "type": "git",
+                                       "url": "https://git.rapsys.eu/userbundle",
+                                       "reference": "master"
+                               },
+                               "autoload": {
+                                       "psr-4": {
+                                               "Rapsys\\UserBundle\\": ""
+                                       }
+                               },
+                               "require": {
+                                       "doctrine/doctrine-bundle": "^1.0|^2.0",
+                                       "rapsys/packbundle": "dev-master",
+                                       "symfony/flex": "^1.0",
+                                       "symfony/form": "^4.0|^5.0",
+                                       "symfony/framework-bundle": "^4.0|^5.0",
+                                       "symfony/security-bundle": "^4.0|^5.0",
+                                       "symfony/validator": "^4.0|^5.0"
+                               }
+                       }
+               }
+       ],
+       ...
 }
 ```
 
@@ -75,24 +87,24 @@ in the `app/AppKernel.php` file of your project:
 // ...
 class AppKernel extends Kernel
 {
-    public function registerBundles()
-    {
-        $bundles = array(
-            // ...
-            new Rapsys\UserBundle\RapsysUserBundle(),
-        );
+       public function registerBundles()
+       {
+               $bundles = array(
+                       // ...
+                       new Rapsys\UserBundle\RapsysUserBundle(),
+               );
 
-        // ...
-    }
+               // ...
+       }
 
-    // ...
+       // ...
 }
 ```
 
 ### Step 3: Configure the Bundle
 
-Setup configuration file `config/packages/rapsys_user.yaml` with the following
-content available in `Rapsys/UserBundle/Resources/config/packages/rapsys_user.yaml`:
+Setup configuration file `config/packages/rapsysuser.yaml` with the following
+content available in `Rapsys/UserBundle/Resources/config/packages/rapsysuser.yaml`:
 
 ```yaml
 #Doctrine configuration
@@ -107,7 +119,7 @@ doctrine:
             Rapsys\UserBundle\Entity\User: 'CustomBundle\Entity\User'
 
 #RapsysUser configuration
-rapsys_user:
+rapsysuser:
     #Class replacement
     class:
         group: 'CustomBundle\Entity\Group'
@@ -125,7 +137,7 @@ rapsys_user:
 #Service configuration
 services:
     #Register security context service
-    rapsys_user.access_decision_manager:
+    rapsysuser.access_decision_manager:
         class: 'Symfony\Component\Security\Core\Authorization\AccessDecisionManager'
         public: true
         arguments: [ [ '@security.access.role_hierarchy_voter' ] ]