X-Git-Url: https://git.rapsys.eu/packbundle/blobdiff_plain/5aa856fcbe21474dd8cef2b1c18861cf043d3247..3ddf076ca3e59ab12b7237bd31702300dcbb3164:/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ebc9136
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+Installation
+============
+
+Applications that use Symfony Flex
+----------------------------------
+
+Open a command console, enter your project directory and execute:
+
+```console
+$ composer require <package-name>
+```
+
+Applications that don't use Symfony Flex
+----------------------------------------
+
+### Step 1: Download the Bundle
+
+Open a command console, enter your project directory and execute the
+following command to download the latest stable version of this bundle:
+
+```console
+$ composer require <package-name>
+```
+
+This command requires you to have Composer installed globally, as explained
+in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
+of the Composer documentation.
+
+### Step 2: Enable the Bundle
+
+Then, enable the bundle by adding it to the list of registered bundles
+in the `app/AppKernel.php` file of your project:
+
+```php
+<?php
+// app/AppKernel.php
+
+// ...
+class AppKernel extends Kernel
+{
+    public function registerBundles()
+    {
+        $bundles = array(
+            // ...
+            new <vendor>\<bundle-name>\<bundle-long-name>(),
+        );
+
+        // ...
+    }
+
+    // ...
+}
+```