Use shortcut version of bundle name resolving to full bundle public resources path

[packbundle] / README.md

diff --git a/README.md b/README.md
index ebc9136397f6568fc605c782eb86323d1aaa6020..ee7b0bb4c39fd037bc8e1b82ab29ce4794b82a3e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,10 +4,38 @@ Installation
 Applications that use Symfony Flex
 ----------------------------------
 
 Applications that use Symfony Flex
 ----------------------------------
 

-Open a command console, enter your project directory and execute:
+Add bundle custom repository to your project's `composer.json` file:
+
+```json
+{
+    ...,
+    "repositories": [
+           {
+                   "type": "package",
+                   "package": {
+                           "name": "rapsys/packbundle",
+                           "version": "dev-master",
+                           "source": {
+                                   "type": "git",
+                                   "url": "https://git.rapsys.eu/packbundle",
+                                   "reference": "master"
+                           },
+                           "autoload": {
+                                   "psr-4": {
+                                           "Rapsys\\PackBundle\\": ""
+                                   }
+                           }
+                   }
+           }
+    ],
+    ...
+}
+```
+
+Then open a command console, enter your project directory and execute:

 
 ```console
 
 ```console

-$ composer require <package-name>
+$ composer require rapsys/packbundle dev-master

 ```
 
 Applications that don't use Symfony Flex
 ```
 
 Applications that don't use Symfony Flex


@@ -19,7 +47,7 @@ Open a command console, enter your project directory and execute the
 following command to download the latest stable version of this bundle:
 
 ```console
 following command to download the latest stable version of this bundle:
 
 ```console

-$ composer require <package-name>
+$ composer require rapsys/packbundle dev-master

 ```
 
 This command requires you to have Composer installed globally, as explained
 ```
 
 This command requires you to have Composer installed globally, as explained


@@ -42,7 +70,7 @@ class AppKernel extends Kernel
     {
         $bundles = array(
             // ...
     {
         $bundles = array(
             // ...

-            new <vendor>\<bundle-name>\<bundle-long-name>(),
+            new Rapsys\PackBundle\RapsysPackBundle(),

         );
 
         // ...
         );
 
         // ...