feat(doc): Add installation documentation and list of first elements

README.md

@@ -1,10 +1,34 @@
-# SyliusUiElementsPlugin
+<h1 align="center">Sylius Ui Elements for Rich Editor</h1>
 
-Library of UiElements for RichEditor
+
+[![Rich Editor Plugin license](https://img.shields.io/github/license/monsieurbiz/SyliusUiElementsPlugin?public)](https://github.com/monsieurbiz/SyliusUiElementsPlugin/blob/master/LICENSE.txt)
+[![Tests Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusUiElementsPlugin/tests.yaml?branch=master&logo=github)](https://github.com/monsieurbiz/SyliusUiElementsPlugin/actions?query=workflow%3ATests)
+[![Recipe Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusUiElementsPlugin/recipe.yaml?branch=master&label=recipes&logo=github)](https://github.com/monsieurbiz/SyliusUiElementsPlugin/actions?query=workflow%3ASecurity)
+[![Security Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusUiElementsPlugin/security.yaml?branch=master&label=security&logo=github)](https://github.com/monsieurbiz/SyliusUiElementsPlugin/actions?query=workflow%3ASecurity)
+
+Library of UiElements for [RichEditor](https://github.com/monsieurbiz/SyliusRichEditorPlugin)
+
+## Compatibility
+
+| Sylius Version | PHP Version |
+|---|---|
+| 1.12 | 8.2 |
+| 1.13 | 8.2 |
 
 ## Installation
 
-TBD
+```bash
+composer require monsieurbiz/sylius-ui-elements-plugin
+```
+
+Et voilà! 🎉
+
+Now, you have access to a set of UiElements for RichEditor.
+
+| FormType           | Shop Template                                                 | Admin Template                                                 |
+|--------------------|---------------------------------------------------------------|----------------------------------------------------------------|
+| HeroUiElementType  | src/Resources/views/Shop/UiElement/hero_ui_element.html.twig  | src/Resources/views/Admin/UiElement/hero_ui_element.html.twig  |
+| LinksUiElementType | src/Resources/views/Shop/UiElement/links_ui_element.html.twig | src/Resources/views/Admin/UiElement/links_ui_element.html.twig |
 
 ## License