Merge pull request #70 from Jibbarth/feature/improve-docs-assetic-injector

improve doc for inject libraries

Author: paulandrieux

Resources/doc/configuration.md

@@ -30,4 +30,123 @@ troopers_alertify:
         translationDomain: messages
     contexts:
     ...
-```
+```
+
+Assetic injections
+------------------
+
+To add libraries in your views, two ways are possible :
+
+#### Use [AsseticInjectorBundle](https://github.com/Troopers/AsseticInjectorBundle)
+
+Add AsseticInjectorBundle in your `composer.json`, and enable it in your `AppKernel.php`.
+
+Then, add injector tag in your javascripts and stylesheets declaration :
+
+```twig
+{% stylesheets injector="alertify-library"
+    '@AppBundle/Resources/public/css/custom.css'
+%}
+    <link rel="stylesheet" href="{{ asset_url }}" type="text/css" />
+{% endstylesheets %}
+
+{% javascripts injector="alertify-library"
+    '@AppBundle/Resources/public/js/custom.js'
+%}
+    <script src="{{ asset_url }}"></script>
+{% endjavascripts %}
+```
+
+Replace `alertify-library` by the library you want to use.
+
+This is the list of available injections :
+- `alertify-toastr`
+- `alertify-noty`
+- `alertify-notie`
+- `alertify-codrops-notification`
+- `alertify-pushjs` - *only for javascripts injection*
+- `foot` : Add confirm.js and alertify.js - *only for javascripts injection*
+
+#### Add the library yourself
+
+This is how embed libraries in your views without AsseticInjectorBundle :
+
+- For **Toastr** :
+```twig
+{% stylesheets
+    '@TroopersAlertifyBundle/Resources/public/toastr/css/toastr.css'
+%}
+    <link rel="stylesheet" href="{{ asset_url }}" type="text/css" />
+{% endstylesheets %}
+
+{% javascripts
+    '@TroopersAlertifyBundle/Resources/public/toastr/js/toastr.js'
+%}
+    <script src="{{ asset_url }}"></script>
+{% endjavascripts %}
+
+```
+
+- For **PushJs** :
+```twig
+{% javascripts
+    '@TroopersAlertifyBundle/Resources/public/push.js/push.min.js'
+%}
+    <script src="{{ asset_url }}"></script>
+{% endjavascripts %}
+
+```
+
+- For **noty** :
+```twig
+{% stylesheets
+    '@TroopersAlertifyBundle/Resources/public/noty/css/jquery.noty.css'
+%}
+    <link rel="stylesheet" href="{{ asset_url }}" type="text/css" />
+{% endstylesheets %}
+
+{% javascripts
+    '@TroopersAlertifyBundle/Resources/public/noty/js/jquery.noty.js'
+%}
+    <script src="{{ asset_url }}"></script>
+{% endjavascripts %}
+
+```
+
+- For **notie** :
+```twig
+{% stylesheets
+    '@TroopersAlertifyBundle/Resources/public/notie/notie.css'
+%}
+    <link rel="stylesheet" href="{{ asset_url }}" type="text/css" />
+{% endstylesheets %}
+
+{% javascripts
+    '@TroopersAlertifyBundle/Resources/public/notie/notie.js'
+%}
+    <script src="{{ asset_url }}"></script>
+{% endjavascripts %}
+
+```
+
+- For **Codrops notification**
+```twig
+{% stylesheets
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/css/ns-default.css",
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/css/ns-style-bar.css",
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/css/ns-style-attached.css",
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/css/ns-style-growl.css",
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/css/ns-style-other.css"
+%}
+    <link rel="stylesheet" href="{{ asset_url }}" type="text/css" />
+{% endstylesheets %}
+
+{% javascripts
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/js/classie.js",
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/js/modernizr.custom.js",
+    "@TroopersAlertifyBundle/Resources/public/codrops-notification/js/notificationFx.js"
+%}
+    <script src="{{ asset_url }}"></script>
+{% endjavascripts %}
+```
+

composer.json

@@ -24,6 +24,9 @@
         "symfony/class-loader": "~2.1",
         "phpunit/phpunit": "~5.7"
     },
+    "suggest": {
+        "troopers/assetic-injector-bundle": "For Inject libraries in your views easily"
+    },
     "autoload": {
         "psr-0": { "Troopers\\AlertifyBundle": "" }
     },