Import licence, readme, composer and manifest

[airbundle] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..1b81b0d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+Installation
+============
+
+Applications that use Symfony Flex
+----------------------------------
+
+Add bundle custom repository to your project's `composer.json` file:
+
+```json
+{
+    ...,
+    "repositories": [
+           {
+                   "type": "package",
+                   "package": {
+                           "name": "rapsys/airbundle",
+                           "version": "dev-master",
+                           "source": {
+                                   "type": "git",
+                                   "url": "https://git.rapsys.eu/airbundle",
+                                   "reference": "master"
+                           },
+                           "autoload": {
+                                   "psr-4": {
+                                           "Rapsys\\AirBundle\\": ""
+                                   }
+                           }
+                   }
+           }
+    ],
+    ...
+}
+```
+
+Then open a command console, enter your project directory and execute:
+
+```console
+$ composer require rapsys/airbundle dev-master
+```
+
+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 rapsys/airbundle dev-master
+```
+
+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 Rapsys\AirBundle\RapsysAirBundle(),
+        );
+
+        // ...
+    }
+
+    // ...
+}
+```