diff --git a/README.md b/README.md index f621ab0c49e1f25dd90769091bb11be5e1b09f7b..25ca028d1720fd4beb97a4b3921465f3b4149e1b 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,52 @@ DBP API project. When including this bundle into your DBP API server it will gain the following features: -* TODO -* TODO -* ... -* profit +* A custom `./bin/console` command +* An example entity +* Various HTTP methods implemented for that entity +## Using the Bundle as a Template + +* Copy the repo contents +* Adjust the project name in `composer.json` +* Invent a new PHP namespace and adjust it in all PHP files +* Rename `src/DbpStarterBundle` and `DependencyInjection/DbpStarterExtension` to match the new project name ## Integration into the API Server -TODO: add to composer, create configuration, note how to see if it works +* Add the repository to your composer.json: + +```json + "repositories": [ + { + "type": "vcs", + "url": "git@gitlab.tugraz.at:dbp/middleware/dbp-api/api-starter-bundle.git" + } + ], +``` + +* Add the package to as a dependency: + +```json + "require": { + ... + "dbp/api-starter-bundle": "@dev", + ... + }, +``` + +* Add the bundle to your `config/bundles.php`: + +```php +... +DBP\API\StarterBundle\DbpStarterBundle::class => ['all' => true], +DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true], +]; +``` ## Development & Testing * Install dependencies: `composer install` * Run tests: `composer test` * Run linters: `composer run lint` -* Run cs-fixed: `composer run cs-fix` \ No newline at end of file +* Run cs-fixer: `composer run cs-fix` \ No newline at end of file