Docs (#99)

* updated the documentation of the bundle

* added changelog

Author: einorler

CHANGELOG.md

@@ -0,0 +1,18 @@
+# CHANGELOG
+
+## v2.0.0 (2017-03-23)
+
+### Breaking Changes
+- Drop PHP 5.5 support. Now only PHP >=5.6 are supported.
+- Drop Symfony 2.7 support. Now only Symfony >=2.8 are supported.
+- Drop Elasticsearch 2.x support. Now only Elasticsearch >=5.0 are supported.
+
+## v1.0.2 (2016-10-03)
+- BUGFIX In compiler pass tags are already processed, so it has to be set in the extension. #96
+
+## v1.0.1 (2016-10-03)
+- Introduced option to disable router alias. This is because if a user already replaces Symfony router by alias and it conflicts with ONGR alias. #91
+- `DocumentUrlGenerator::support()` function cannot throw exception due to `VersatileGeneratorInterface` interface description. Now it returns false instead. #92
+
+## v1.0.0 (2016-04-05)
+- Initial release

README.md

@@ -72,9 +72,6 @@ ongr_elasticsearch:
     connections:
         default:
             index_name: acme
-            analysis:
-                analyzer:
-                    - urlAnalyzer
     managers:
         default:
             connection: default
@@ -95,9 +92,6 @@ ongr_router:
 
 In the configuration of the bundle you need to specify the `es.manager` to use and under the `seo_routes` you have to specify documents that will have seo_routes as keys and the controller action that will handle the request as a values.
 
-At `_controller` you define controller and action for every document type.
-`_route` is a name of this route and it can be used at path generation.
-
 `urlAnalyzer` at `ongr_elasticsearch` configuration defines how all url fields are analyzed by Elasticsearch.
 
 If you are using another third party bundle that also has an aliased Symfony router, you may set `disable_alias` to `true`. This
@@ -107,7 +101,7 @@ prevents possible conflicts.
 is set to the chain router. It defaults to -100 in order to be called after the standard Symfony router
 but this value can be changed depending on your projects' need.
 
-Check [Elasticsearch bundle mappings docs](https://github.com/ongr-io/ElasticsearchBundle/blob/master/Resources/doc/mapping.md) for more information about the configuration.
+Check [Elasticsearch bundle mappings docs](http://docs.ongr.io/ElasticsearchBundle/mapping) for more information about the configuration.
 
 
 ## Usage example
@@ -133,7 +127,7 @@ class Product implements SeoAwareInterface
     use SeoAwareTrait; // <- Trait for URL's
 
     /**
-     * @ES\Property(type="string")
+     * @ES\Property(type="keyword")
      */
     public $title;
 
@@ -175,7 +169,7 @@ Create an elasticsearch index by running this command in your terminal:
     
 ```
 
-> More info about all commands can be found in the [Elasticsearch bundle commands chapter](https://github.com/ongr-io/ElasticsearchBundle/blob/master/Resources/doc/commands.md).
+> More info about all commands can be found in the [Elasticsearch bundle commands chapter](http://docs.ongr.io/ElasticsearchBundle/commands).
 
 Also, run the following curl command in your terminal to insert a product for this demonstration.
 

Resources/doc/index.md renamed to Resources/doc/how_it_works.md

@@ -1,14 +1,8 @@
-# ONGR Router Bundle
+# How it works
 
-Welcome to the RouterBundle, the part of ONGR bundles family, which helps to have pretty urls for every elasticsearch document. We created this bundle with love :heart: and we think you will love it too.
+## URL generation
 
-> You can find bundle set up guide in the [`README.md`](../../README.md) file. 
-
-## How it works
-
-### URL generation
-
-When your document uses [SeoAwareTrait](https://github.com/ongr-io/RouterBundle/blob/master/Document/SeoAwareTrait.php) you have protected property called `$url`. It contains the url for specific document,which is used for url generation.
+When your document uses [SeoAwareTrait](https://github.com/ongr-io/RouterBundle/blob/master/Document/SeoAwareTrait.php) you have private property called `$url`. It contains the url for specific document,which is used for url generation.
 
 Your document must be defined in the configuration of the bundle, under the node `seo_routes`. There you will define the bundle, controller and action that will be called after the router matches the route in your document.
 
@@ -27,16 +21,16 @@ In order to generate link to this document (referenced by variable `product`) we
 
 > The route `ongr_route_product` is generated from `seo_routes` parameter type name, so it's formed by: `ongr_route_<type-name>`.
 
-### URL matching
+## URL matching
 
-As shown in [README example](../../README.md#step-4-create-an-action-for-product-page) when url matches document, real object representing document is passed to action instead of original string from URI. This is how it works:
+As shown in [README example](http://docs.ongr.io/RouterBundle) when url matches document, real object representing document is passed to action instead of original string from URI. This is how it works:
 - Symfony chain router begins to parse request.
 - By default there are two routers registered in the chain: standard Symfony router and ONGR router.
 - If Symfony router does not match any routes for given URI it is passed to ONGR router.
 - ONGR router queries ES to get document by URI.
 - If query returned document it is passed to action, if not - NotFound exception is thrown.
 
-> Note that it is default behaviour and it can be easily changed by adding and removing routers from chain. [More info](chain_router.md)
+> Note that it is default behaviour and it can be easily changed by adding and removing routers from chain. [More info](http://docs.ongr.io/RouterBundle/chain_router)
 
 ## Advanced usage
-* [How to add custom router](chain_router.md)
+* [How to add custom router](http://docs.ongr.io/RouterBundle/chain_router)