diff --git a/README.md b/README.md index e6931db..9f68379 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,22 @@ # SuluEventBundle! -This bundle was made based on pr of https://github.com/sulu/sulu-workshop. -I made it to quickly install those entities in my projects. -This bundle is still in development. Use at own risk :) +This bundle was made based on [Sulu workshop](https://github.com/sulu/sulu-workshop). +I made it to quickly install the possibility to manage events in my projects. +This bundle is still in development. Use at own risk ๐ค๐ป -[![Build Status](https://www.travis-ci.com/manuxi/SuluEventBundle.svg?branch=main)](https://www.travis-ci.com/manuxi/SuluEventBundle) +
-## Installation +## ๐ฉ๐ปโ๐ญ Installation Install the package with: ```console composer require manuxi/sulu-event-bundle @@ -13,7 +24,10 @@ composer require manuxi/sulu-event-bundle If you're *not* using Symfony Flex, you'll also need to add the bundle in your `config/bundles.php` file: ```php -Manuxi\SuluEventBundle\SuluEventBundle::class => ['all' => true], +return [ + //... + Manuxi\SuluEventBundle\SuluEventBundle::class => ['all' => true], +]; ``` Please add the following to your `routes_admin.yaml`: ```yaml @@ -39,11 +53,10 @@ Execute the queries above with: php bin/console doctrine:schema:update --force ``` -## Usage +## ๐ฃ Usage After granting the rights in the sulu admin area you should be able to create locations and events. use smart_content property type to show a list of events, e.g.: ```xml -...