diff --git a/README.md b/README.md index 7a90aaf..ddaa45b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,27 @@ Easily add scalar metadata to a Symfony entity via the use of a key-value interface. +# Installation +1. Add this repository to `composer.json`: +```json +"repositories": [ + { + "type": "vcs", + "url": "ssh://git@git.pcmdev.co.uk:2222/pcm-libraries/pcm-metadata-bundle.git" + } +], +``` +2. Install the bundle: +```sh +composer require pcm/metadata-bundle +``` +3. If not set already add the following config to `doctrine.yaml` to prevent errors: +```yaml +doctrine: + orm: + enable_native_lazy_objects: true +``` + # Usage 1. Use the `MetadataTrait` inside an entity: ```php