update readme

README.md

@@ -1,11 +1,11 @@
 # ONGR Elasticsearch Bundle
 
 Elasticsearch Bundle was created in order to serve the need for
-professional [Elasticsearch](https://www.elastic.co/products/elasticsearch) integration with enterprise level Symfony
+professional [Elasticsearch][1] integration with enterprise level Symfony
 applications. This bundle is:
 
-* Supported by [ONGR.io](http://ongr.io) development team.
-* Uses the official [elasticsearch-php](https://github.com/elastic/elasticsearch-php) client.
+* Supported by [ONGR.io][2] development team.
+* Uses the official [elasticsearch-php][3] client.
 * Ensures full integration with Symfony framework.
 
 Technical goodies:
@@ -18,7 +18,7 @@ Technical goodies:
 * Profiler that integrates in the Symfony debug bar and shows all executed queries.
 * Designed in an extensible way for all your custom needs.
 
-If you need any help, [stack overflow](http://stackoverflow.com/questions/tagged/ongr)
+If you need any help, [stack overflow][4]
 is the preferred and recommended way to ask questions about ONGR bundles and libraries.
 
 
@@ -40,25 +40,35 @@ is the preferred and recommended way to ask questions about ONGR bundles and lib
 
 ## Documentation
 
-The online documentation of the bundle can be found in [http://docs.ongr.io](http://docs.ongr.io/ElasticsearchBundle).
+The online documentation of the bundle can be found in [http://docs.ongr.io][5].
 Docs source is stored within the repo under `Resources/doc/`, so if you see a typo or problem, please submit a PR to fix it!
 
-For contribution to the documentation you can find it in the [contribute](Resources/doc/contribute.md) topic.
+For contribution to the documentation you can find it in the [contribute][6] topic.
 
+## FAQ
+* [Mapping explained][7]
+* [Using Meta-Fields][8]
+* [Configuration][9]
+* [Console commands][10]
+* [How to do a simple CRUD actions][11]
+* [Quick find functions][12]
+* [How to search the index][13]
+* [Scan through the index][14]
+* [Parsing the results][15]
 
 ## Setup the bundle
 
 #### Step 1: Install Elasticsearch bundle
 
-Elasticsearch bundle is installed using [Composer](https://getcomposer.org).
+Elasticsearch bundle is installed using [Composer][16].
 
 ```bash
 php composer.phar require ongr/elasticsearch-bundle "~2.0"
 
 ```
 
 > Instructions for installing and deploying Elasticsearch can be found in
- [Elasticsearch installation page](https://www.elastic.co/downloads/elasticsearch).
+ [Elasticsearch installation page][17].
 
 Enable Elasticsearch bundle in your AppKernel:
 
@@ -95,10 +105,10 @@ ongr_elasticsearch:
 
 ```
 
-> This is the very basic example only, for more information, please take a look at the [configuration](Resources/doc/configuration.md) chapter.
+> This is the very basic example only, for more information, please take a look at the [configuration][9] chapter.
 
 In this particular example there are 2 things you should know. The index name in the index node and the mappings.
- Mappings is the place where your documents are stored (more info at [the mapping chapter](Resources/doc/mapping.md)).
+ Mappings is the place where your documents are stored (more info at [the mapping chapter][7]).
 
 
 #### Step 3: Define your Elasticsearch types as `Document` objects
@@ -135,7 +145,7 @@ class Customer
 ```
 
 > This is the basic example only, for more information about mapping, please take a look
- at the [the mapping chapter](http://docs.ongr.io/ElasticsearchBundle/mapping).
+ at the [the mapping chapter][7].
 
 
 #### Step 4: Create index and mappings
@@ -148,17 +158,42 @@ bin/console ongr:es:index:create
 
 ```
 
-> More info about the rest of the commands can be found in the [commands chapter](http://docs.ongr.io/ElasticsearchBundle/commands).
+> More info about the rest of the commands can be found in the [commands chapter][10].
 
 
 #### Step 5: Enjoy with the Elasticsearch
 
-We advise to take a look at the [mapping chapter](http://docs.ongr.io/ElasticsearchBundle/mapping) to configure the index.
- Search documentation for the Elasticsearch bundle is [available here](http://docs.ongr.io/ElasticsearchBundle/search).
- And finally it's up to you what amazing things you are going to create :sunglasses: .
+We advise to take a look at the [mapping chapter][7] to configure the index.
+Search documentation for the Elasticsearch bundle is [available here][13].
+And finally it's up to you what amazing things you are going to create :sunglasses: .
 
+## Troubleshooting
+* [How to upgrade from the older versions?][18]
+* [How to overwrite some parts of the bundle?][19]
 
 ## License
 
 This bundle is licensed under the MIT license. Please, see the complete license
 in the bundle `LICENSE` file.
+
+
+
+[1]: https://www.elastic.co/products/elasticsearch
+[2]: http://ongr.io
+[3]: https://github.com/elastic/elasticsearch-php
+[4]: http://stackoverflow.com/questions/tagged/ongr
+[5]: http://docs.ongr.io/ElasticsearchBundle
+[6]: http://docs.ongr.io/common/Contributing
+[7]: http://docs.ongr.io/ElasticsearchBundle/mapping
+[8]: http://docs.ongr.io/ElasticsearchBundle/meta_fields
+[9]: http://docs.ongr.io/ElasticsearchBundle/configuration
+[10]: http://docs.ongr.io/ElasticsearchBundle/commands
+[11]: http://docs.ongr.io/ElasticsearchBundle/crud
+[12]: http://docs.ongr.io/ElasticsearchBundle/find_functions
+[13]: http://docs.ongr.io/ElasticsearchBundle/search
+[14]: http://docs.ongr.io/ElasticsearchBundle/scan
+[15]: http://docs.ongr.io/ElasticsearchBundle/results_parsing
+[16]: https://getcomposer.org
+[17]: https://www.elastic.co/downloads/elasticsearch
+[18]: http://docs.ongr.io/ElasticsearchBundle/upgrade
+[19]: http://docs.ongr.io/ElasticsearchBundle/overwriting_bundle