#5 - Main documentation files

README.md

@@ -1,41 +1,9 @@
-# Quiz bundle for Symfony2/Doctrine2
-This bundle is intended to easyly provide a website or application with Quizes or, what is the same, groups of
-questions and answers
+# Provinces bundle for Symfony2/Doctrine2
 
-Features included as of 0.9.x
+This bundle is intended to allow you to easily have the basic structure of regions-provinces of a given country (or all,
+I hope).
 
-- Quiz, Questions and Answers are stored with Doctrine 2 ORM
-- Quizes have a UUID allowing you to set your own link between Answers and Users
-- Questions responses are featured as serilized objects to allow greater flexibility
+[![Build
+Status](https://secure.travis-ci.org/egulias/EguliasQuizBundle.png)](http://travis-ci.org/egulias/EguliasQuizBundle)
 
-Documentation
--------------
 
-The bulk of the documentation is stored in the `Resources/doc/index.md`
-file in this bundle:
-
-[Read the Documentation](https://github.com/egulias/EguliasQuizBundle/blob/master/Resources/doc/index.md)
-
-
-Installation
-------------
-
-All the installation instructions are located in [documentation](https://github.com/egulias/EguliasQuizBundle/blob/master/Resources/doc/index.md).
-
-License
--------
-
-This bundle is under the MIT license. See the complete license in the bundle:
-
-[License](https://github.com/egulias/EguliasQuizBundle/blob/master/Resources/meta/LICENCE)
-
-
-Reporting an issue or a feature request
----------------------------------------
-
-Issues and feature requests are tracked in the [Github issue tracker](https://github.com/egulias/EguliasQuizBundle/issues).
-
-When reporting a bug, it may be a good idea to reproduce it in a basic project
-built using the [Symfony Standard Edition](https://github.com/symfony/symfony-standard)
-to allow developers of the bundle to reproduce the issue by simply cloning it
-and following some steps.

Resources/doc/installation.md

@@ -0,0 +1,67 @@
+# Installation and configuration
+
+## Get the bundle
+
+Add to your `/deps` file :
+
+```
+[EguliasQuizBundle]
+    [email protected]:egulias/EguliasQuizBundle.git
+    target=/bundles/Egulias/QuizBundle
+```
+  * Side note: remember to add the `version=` tag if you need a particular version
+
+And make a `php bin/vendors install`.
+
+## Register the namespace
+
+``` php
+<?php
+
+  // app/autoload.php
+  $loader->registerNamespaces(array(
+      'Egulias' => __DIR__.'/../vendor/bundles',
+      // your other namespaces
+      ));
+```
+
+## Add EguliasQuizBundle to your application kernel
+
+``` php
+<?php
+
+  // app/AppKernel.php
+  public function registerBundles()
+  {
+    return array(
+      // ...
+      new Egulias\QuizBundle\EguliasQuizBundle(),
+      // ...
+      );
+  }
+```
+
+## Update the database
+
+Assuming you are working with Dcotrine 2 for Symfony 2 you need to update your schema as follows:
+
+### Confirm the schema needs update
+``` 
+app/console doctrine:schema:update
+```
+
+### Update the schema 
+``` 
+app/console doctrine:schema:update --force
+```
+
+## URLs
+
+This bundle uses Annotations for its routing so you will find them inside each controller.
+In order to use the bundle out of the box you need to import the routing file in your main routing.yml as follows:
+``` yml
+EguliasQuizBundle:
+    resource: "@EguliasQuizBundle/Controller/"
+    type:     annotation
+    prefix:   /
+```

Resources/doc/usage.md

@@ -0,0 +1,6 @@
+# Usage
+
+The QuizBundle comes with a set of predefined urls to point to basic controllers so you can start using the bundle
+out of the box.
+
+