]> Raphaël G. Git Repositories - packbundle/commitdiff
Add contribute
authorRaphaël Gertz <git@rapsys.eu>
Mon, 3 Oct 2022 03:28:48 +0000 (05:28 +0200)
committerRaphaël Gertz <git@rapsys.eu>
Mon, 3 Oct 2022 03:28:48 +0000 (05:28 +0200)
Update readme

README.md

index 3998c89a9180a7667e3146ee3f6a84b2844a429a..fee1d961777bd3c3f4ba6330a087319cc65e721c 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
 ============
 
 Installation
 ============
 
@@ -8,35 +20,34 @@ Add bundle custom repository to your project's `composer.json` file:
 
 ```json
 {
 
 ```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\\": ""
-                                   }
-                },
-                "require": {
-                    "symfony/asset": "^4.4",
-                    "symfony/flex": "^1.5",
-                    "symfony/framework-bundle": "^4.4",
-                    "symfony/process": "^4.4",
-                    "symfony/twig-bundle": "^4.4",
-                    "twig/extensions": "^1.5"
-                           }
-                   }
-           }
-    ],
-    ...
+       ...,
+       "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\\": ""
+                                       }
+                               },
+                               "require": {
+                                       "symfony/asset": "^4.0|^5.0",
+                                       "symfony/flex": "^1.0",
+                                       "symfony/framework-bundle": "^4.0|^5.0",
+                                       "symfony/process": "^4.0|^5.0",
+                                       "symfony/twig-bundle": "^4.0|^5.0"
+                               }
+                       }
+               }
+       ],
+       ...
 }
 ```
 
 }
 ```
 
@@ -74,17 +85,17 @@ in the `app/AppKernel.php` file of your project:
 // ...
 class AppKernel extends Kernel
 {
 // ...
 class AppKernel extends Kernel
 {
-    public function registerBundles()
-    {
-        $bundles = array(
-            // ...
-            new Rapsys\PackBundle\RapsysPackBundle(),
-        );
+       public function registerBundles()
+       {
+               $bundles = array(
+                       // ...
+                       new Rapsys\PackBundle\RapsysPackBundle(),
+               );
 
 
-        // ...
-    }
+               // ...
+       }
 
 
-    // ...
+       // ...
 }
 ```
 
 }
 ```
 
@@ -96,32 +107,78 @@ content available in `Resources/config/packages/rapsys_pack.yaml`:
 ```yaml
 #Services configuration
 services:
 ```yaml
 #Services configuration
 services:
-    #Replace assets.packages definition
-    assets.packages:
-        class: 'Symfony\Component\Asset\Packages'
-        arguments: [ '@rapsys_pack.path_package' ]
-    #Replace assets.context definition
-    assets.context:
-        class: 'Rapsys\PackBundle\Context\RequestStackContext'
-        arguments: [ '@request_stack', '%asset.request_context.base_path%', '%asset.request_context.secure%' ]
-    #Register assets pack package
-    rapsys_pack.path_package:
-        class: 'Rapsys\PackBundle\Package\PathPackage'
-        arguments: [ '/', '@assets.empty_version_strategy', '@assets.context' ]
-        public: true
-    #Register twig pack extension
-    rapsys_pack.pack_extension:
-        class: 'Rapsys\PackBundle\Extension\PackExtension'
-        arguments: [ '@file_locator', '@service_container', '@rapsys_pack.path_package', '@rapsys_pack.slugger_util' ]
-        tags: [ 'twig.extension' ]
-    #Register slugger util service
-    rapsys_pack.slugger_util:
-        class: 'Rapsys\PackBundle\Util\SluggerUtil'
-        arguments: [ '%kernel.secret%' ]
-        public: true
-    #Register slugger util class alias
-    Rapsys\PackBundle\Util\SluggerUtil:
-        alias: 'rapsys_pack.slugger_util'
+       #Replace assets.packages definition
+       assets.packages:
+               class: 'Symfony\Component\Asset\Packages'
+               arguments: [ '@rapsys_pack.path_package' ]
+       #Replace assets.context definition
+       assets.context:
+               class: 'Rapsys\PackBundle\Context\RequestStackContext'
+               arguments: [ '@request_stack', '%asset.request_context.base_path%', '%asset.request_context.secure%' ]
+       #Register assets pack package
+       rapsys_pack.path_package:
+               class: 'Rapsys\PackBundle\Package\PathPackage'
+               arguments: [ '/', '@assets.empty_version_strategy', '@assets.context' ]
+               public: true
+       #Register twig pack extension
+       rapsys_pack.pack_extension:
+               class: 'Rapsys\PackBundle\Extension\PackExtension'
+               arguments: [ '@service_container', '@rapsys_pack.intl_util', '@file_locator', '@rapsys_pack.path_package', '@rapsys_pack.slugger_util' ]
+               tags: [ 'twig.extension' ]
+       #Register intl util service
+       rapsys_pack.intl_util:
+               class: 'Rapsys\PackBundle\Util\IntlUtil'
+               public: true
+       #Register facebook event subscriber
+       Rapsys\PackBundle\Subscriber\FacebookSubscriber:
+               arguments: [ '@router', '%rapsys_air.locales%' ]
+               tags: [ 'kernel.event_subscriber' ]
+       #Register intl util class alias
+       Rapsys\PackBundle\Util\IntlUtil:
+               alias: 'rapsys_pack.intl_util'
+       #Register facebook util service
+       rapsys_pack.facebook_util:
+               class: 'Rapsys\PackBundle\Util\FacebookUtil'
+               arguments: [ '@router', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ]
+               public: true
+       #Register facebook util class alias
+       Rapsys\PackBundle\Util\FacebookUtil:
+               alias: 'rapsys_pack.facebook_util'
+       #Register image util service
+       rapsys_pack.image_util:
+               class: 'Rapsys\PackBundle\Util\ImageUtil'
+               arguments: [ '@router', '@rapsys_pack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ]
+               public: true
+       #Register image util class alias
+       Rapsys\PackBundle\Util\ImageUtil:
+               alias: 'rapsys_pack.image_util'
+       #Register map util service
+       rapsys_pack.map_util:
+               class: 'Rapsys\PackBundle\Util\MapUtil'
+               arguments: [ '@router', '@rapsys_pack.slugger_util' ]
+               public: true
+       #Register map util class alias
+       Rapsys\PackBundle\Util\MapUtil:
+               alias: 'rapsys_pack.map_util'
+       #Register slugger util service
+       rapsys_pack.slugger_util:
+               class: 'Rapsys\PackBundle\Util\SluggerUtil'
+               arguments: [ '%kernel.secret%' ]
+               public: true
+       #Register slugger util class alias
+       Rapsys\PackBundle\Util\SluggerUtil:
+               alias: 'rapsys_pack.slugger_util'
+       #Register image controller
+       Rapsys\PackBundle\Controller\ImageController:
+               arguments: [ '@service_container', '@rapsys_pack.image_util', '@rapsys_pack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ]
+               tags: [ 'controller.service_arguments' ]
+       #Register map controller
+       Rapsys\PackBundle\Controller\MapController:
+               arguments: [ '@service_container', '@rapsys_pack.map_util', '@rapsys_pack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ]
+               tags: [ 'controller.service_arguments' ]
+       Rapsys\PackBundle\Form\CaptchaType:
+               arguments: [ '@rapsys_pack.image_util', '@rapsys_pack.slugger_util', '@translator' ]
+               tags: [ 'form.type' ]
 ```
 
 Open a command console, enter your project directory and execute the following
 ```
 
 Open a command console, enter your project directory and execute the following