Update docs

README.md

@@ -34,7 +34,7 @@ The Dynamic Search Bundle allows you to redefine your search strategy. It's base
 ## Further Information
 - [Example Setup](docs/0_ExampleSetup.md)
 - [Configuration](#)
-    - [Context Guard](#)
+    - [Context Guard](docs/1_Configuration/0_Context Guard.md)
     - [Document Definition](#)
     - [Logging](#)
 - [Data Creation](#)

docs/0_ExampleSetup.md

@@ -3,9 +3,9 @@
 ### composer.json
 ```json
 "require" : {
-    "dachcom-digital/dynamic-search": "~0.7.0",
-    "dachcom-digital/dynamic-search-data-provider-trinity": "~0.7.0",
-    "dachcom-digital/dynamic-search-index-provider-lucene": "~0.7.0",
+    "dachcom-digital/dynamic-search": "~1.0.0",
+    "dachcom-digital/dynamic-search-data-provider-trinity": "~1.0.0",
+    "dachcom-digital/dynamic-search-index-provider-lucene": "~1.0.0",
 }
 ```
 

docs/1_Configuration/0_Context Guard.md

@@ -0,0 +1,40 @@
+# Context Guard
+
+The context guard add an additional layer of protection and controll ontop of the set of your indexing rules. It allows you to filter the result and avoid indexing unvanted content.
+
+To  implement a guard add a service that would implement `ContextGuardInterface`.
+
+## Example Setup
+
+``` yaml
+services:
+  AppBundle\DynamicSearch\Guard\DefaultContextGuard:
+    tags:
+      - { name: dynamic_search.context_guard }
+```
+This simple guard will prevent the document with the id 1 (it is the root document in the pimcore document tree) to be added to the index.
+
+``` php
+<?php
+
+namespace AppBundle\DynamicSearch\Guard;
+
+use DynamicSearchBundle\Guard\ContextGuardInterface;
+use DynamicSearchBundle\Normalizer\Resource\ResourceMetaInterface;
+
+class DefaultContextGuard implements ContextGuardInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function verifyResourceMetaForContext(string $contextName, ResourceMetaInterface $resourceMeta)
+    {
+        if ($resourceMeta->getResourceId() > 1) {
+            return true;
+        }
+
+        return false;
+    }
+}
+
+```