Merge branch 'release/v1.0.1'

Florian Eckerstorfer · Florian Eckerstorfer · commit ff383c4d6eeb · 2012-09-14T00:46:32.000+02:00
* release/v1.0.1:
  Updated README
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Florian Eckerstorfer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -8,12 +8,41 @@ About
 
 BraincraftedBootstrapBundle is [Bootstrap, from Twitter](http://twitter.github.com/bootstrap/) encapsulated in a [Symfony2](http://symfony.com) bundle.
 
-**Fair Warning**: This is in a very early development stage. Currently there are only the required stylesheets, JavaScripts and icons included and I started to include the form styles as Twig templates.
+Installation
+------------
 
-Todo
-----
+First you need to add BraincraftedBootstrapBundle to `composer.json`:
 
-- Form styles
-- Navigation/Menu (using [KnpMenuBundle](https://github.com/KnpLabs/KnpMenuBundle))
+    {
+       "require": {
+            "braincrafted/bootstrap-bundle": "dev-master"
+        }
+    }
 
-(This list of todos may grow as I think of more.)
+and you have to add the bundle to your `AppKernel.php`:
+
+    // app/AppKernel.php
+    ...
+    class AppKernel extends Kernel
+    {
+        ...
+        public function registerBundles()
+        {
+            $bundles = array(
+                ...
+                new Braincrafted\BootstrapBundle\BraincraftedBootstrapBundle()
+            );
+            ...
+
+            return $bundles;
+        }
+        ...
+    }
+
+Then you should check out the [documentation](http://bootstrap.braincrafted.com) to find out how you can use BraincraftedBootstrapBundle in your Symfony2 project.
+
+License
+-------
+
+- The bundle is licensed under the [MIT License](http://opensource.org/licenses/MIT)
+- The CSS and Javascript from the Twitter Bootstrap are licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
