diff --git a/README.md b/README.md index 3b8d11f..04ee5b1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,34 @@ -# SyliusUiElementsPlugin +

Sylius Ui Elements for Rich Editor

-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 diff --git a/src/Controller/.gitignore b/src/Controller/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/src/Entity/.gitignore b/src/Entity/.gitignore deleted file mode 100644 index e69de29..0000000