update readme

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2011-2012 Lexik <[email protected]>
+Copyright (C) 2011-2019 Lexik <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,5 +1,5 @@
-Overview
-========
+LexikFormFilterBundle
+=====================
 
 This Symfony bundle aims to provide classes to build some form types dedicated to filter an entity.
 Once you created your form type you will be able to update a doctrine query builder conditions from a form type.
@@ -19,12 +19,49 @@ The idea is:
 Documentation
 =============
 
-This `Symfony3.0` branch is compatible with Symfony 2.8/3.0 or higher.
+This Symfony bundle is compatible with Symfony 4.3 or higher.
+
+For Symfony 2.8/3.4 please use tags v5.*
 
 For installation and how to use the bundle refer to [Resources/doc/index.md](Resources/doc/index.md)
 
-Running the test suite
-======================
+1. [Installation](Resources/doc/installation.md)
+2. [Configuration](Resources/doc/configuration.md)
+3. [Provided form types](Resources/doc/provided-types.md)
+4. [Example & inner workings](Resources/doc/basics.md)
+    1. [Simple example](Resources/doc/basics.md#i-simple-example)
+    2. [Inner workings](Resources/doc/basics.md#ii-inner-workings)
+5. [Working with the filters](Resources/doc/working-with-the-bundle.md)
+    1. [Customize condition operator](Resources/doc/working-with-the-bundle.md#i-customize-condition-operator)
+    2. [Filter customization](Resources/doc/working-with-the-bundle.md#ii-filter-customization)
+    3. [Working with entity associations and embeddeding filters](Resources/doc/working-with-the-bundle.md#iii-working-with-entity-associations-and-embeddeding-filters)
+    4. [Doctrine embeddables](Resources/doc/working-with-the-bundle.md#iv-doctrine-embeddables-orm)
+    5. [Create your own filter type](Resources/doc/working-with-the-bundle.md#v-create-your-own-filter-type)
+    6. [Enable validation on your filter type](Resources/doc/working-with-the-bundle.md#vi-enable-filtertype-form-validation)
+6. [The FilterTypeExtension](Resources/doc/filtertypeextension.md)
+7. [Working with other bundles](Resources/doc/working-with-other-bundles.md)
+    1. [KNP Paginator example](Resources/doc/working-with-other-bundles.md#i-knp-paginator-example)
+
+Community Support
+-----------------
+
+Please consider [opening a question on StackOverflow](http://stackoverflow.com/questions/ask) using the [`lexikformfilterbundle` tag](http://stackoverflow.com/questions/tagged/lexikformfilterbundle),  it is the official support platform for this bundle.
+
+Github Issues are dedicated to bug reports and feature requests.
+
+Symfony 2.8 and 3.4
+-------------------
+
+Please use last tag v5.*
+
+Credits
+-------
+
+* Lexik <[email protected]>
+* [All contributors](https://github.com/lexik/LexikFormFilterBundle/graphs/contributors)
+
+License
+-------
 
-    composer install
-    bin/phpunit
+This bundle is under the MIT license.  
+For the whole copyright, see the [LICENSE](LICENSE) file distributed with this source code.

Resources/doc/working-with-the-bundle.md

@@ -564,7 +564,7 @@ $qbUpdater->setParts(array(
 $qbUpdater->addFilterConditions($form, $queryBuilder);
 ```
 
-iv. Doctrine embeddables (ORM)
+iv. Doctrine embeddables ORM
 ------------------------------
 
 Here an example about how to create embedded filter types with Doctrine2 embeddables objects.