diff --git a/README.md b/README.md index ff3ae2e797d943e3b80040fd27eb4f9c4dc050f3..95adaf05d1df9f59b6b2d53b2134f534edbdf0a4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # API-Base-Bundle -Contains Entities required by many bundles \ No newline at end of file +[GitLab](https://gitlab.tugraz.at/dbp/relay/api-base-bundle) | [Packagist](https://packagist.org/packages/dbp/api-base-bundle) + +This Symfony bundle contains entities required by many bundles for the DBP Relay project. + +## Integration into the API Server + +* Add the bundle package as a dependency: + +``` +composer require dbp/api-base-bundle +``` + +* Add the bundle to your `config/bundles.php`: + +```php +... +DBP\API\BaseBundle\DbpBaseBundle::class => ['all' => true], +DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true], +]; +``` + +* Run `composer install` to clear caches +