From 16070cd1997f2990e7345eb5cfda47eb23ecbf54 Mon Sep 17 00:00:00 2001
From: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>
Date: Wed, 20 Oct 2021 13:47:43 +0200
Subject: [PATCH] IBX-1190: Updated readme to fit new template

For more details see https://issues.ibexa.co/browse/IBX-1190 and https://github.com/ezsystems/ezplatform-query-fieldtype/pull/59

Co-authored-by: DominikaK <DominikaK@users.noreply.github.com>
---
 README.md | 64 ++++++-------------------------------------------------
 1 file changed, 6 insertions(+), 58 deletions(-)

diff --git a/README.md b/README.md
index 5c8aad1..88d60bc 100644
--- a/README.md
+++ b/README.md
@@ -1,71 +1,19 @@
 # Ibexa Query Field Type
 
-This Field Type will let a content manager map an executable Repository Query to a Field.
+This package is part of [Ibexa DXP](https://ibexa.co).
 
-Example use-cases:
-- a `place.nearby_places` field that returns Place items less than X kilometers away
-  from the current content, based on its own `location` field
-- a `gallery.images` field that returns Image items that are children of the current
-  gallery item's main location
+To use this package, [install Ibexa DXP](https://doc.ibexa.co/en/latest/install/).
 
-The idea is to move content and structure logic implemented in controllers and templates
-to the repository itself.
+This package contains the Query Field Type for [Ibexa DXP](https://ibexa.co).
 
-## Installation
-Add the package to the requirements:
-```
-composer require ezsystems/ezplatform-query-fieldtype:^1.0@dev
-```
-
-Enable the bundle:
-```php
-// config/bundles.php
-
-return [
-  // ...
-  EzSystems\EzPlatformQueryFieldType\Symfony\EzSystemsEzPlatformQueryFieldTypeBundle::class => ['all' => true],
-  // ..
-];
-```
-
-Add the bundle routes to `config/routing.yaml`:
-```yml
-ezplatform.query_fieldtype.routes:
-    resource: '@EzSystemsEzPlatformQueryFieldTypeBundle/Resources/config/routing/'
-    type: directory
-```
-
-## Usage
-Add a Content query field to a content type.
-
-In the Field Definition settings, select a Query Type from the list, as well as the content type that is returned by that field.
-
-Parameters are used to build the query on runtime. They are either static, or mapped to properties from the content
-the field value belongs to. The syntax YAML, with the key being the name of a query type parameter, and the value
-either a scalar, or an [expression](https://symfony.com/doc/current/components/expression_language.html).
-
-The following variables are available for use in expressions:
-- `string returnedType`: the identifier of the content type that was previously selected
-- `eZ\Publish\API\Values\Content\Content content`: the current content item
-  Also gives you access to fields values. Example with an `ezurl` field: `@=content.getFieldValue('url').link`
-- `eZ\Publish\API\Values\Content\ContentInfo contentInfo`: the current content item's content info
-- `eZ\Publish\API\Values\Content\Location mainLocation`: the current content item's main location
-
-A simple example, for a LocationChildren query type that expects:
-- `parent_location_id`: id of the location to fetch children for
-- `content_types`: content type identifier or array of identifiers to filter on
-
-````yaml
-parent_location_id: "@=mainLocation.id"
-content_types: "@=returnedType"
-````
-
-See the [`examples`](doc/examples/) directory for full examples.
+This Field Type allows the content manager to map an executable Repository Query to a Field.
 
 ## COPYRIGHT
+
 Copyright (C) 1999-2021 Ibexa AS (formerly eZ Systems AS). All rights reserved.
 
 ## LICENSE
+
 This source code is available separately under the following licenses:
 
 A - Ibexa Business Use License Agreement (Ibexa BUL),