From b11561fe5cf2a59d2a324f2d4c763fb0e69cd998 Mon Sep 17 00:00:00 2001
From: Christoph Reiter <reiter.christoph@gmail.com>
Date: Mon, 12 Apr 2021 10:44:23 +0200
Subject: [PATCH] README: some clarifications
Install from a fixed branch to avoid it picking a feature branch.
Use composer when adding the dep.
Use the real name in the example commands.
---
README.md | 16 +++++++---------
1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index fd299af..3949663 100644
--- a/README.md
+++ b/README.md
@@ -30,14 +30,10 @@ features:
],
```
-* Add the package to as a dependency:
+* Add the bundle package as a dependency:
-```json
- "require": {
- ...
- "dbp/api-starter-bundle": "@dev",
- ...
- },
+```
+composer require dbp/api-starter-bundle=dev-main
```
* Add the bundle to your `config/bundles.php`:
@@ -49,6 +45,8 @@ DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true],
];
```
+* Run `composer install` to clear caches
+
## Development & Testing
* Install dependencies: `composer install`
@@ -61,6 +59,6 @@ DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true],
Don't forget you need to pull down your dependencies in your main application if you are installing packages in a bundle.
```bash
-# installs dependencies from dbp/api-your-bundle
-composer update dbp/api-your-bundle
+# updates and installs dependencies from dbp/api-starter-bundle
+composer update dbp/api-starter-bundle
```
--
GitLab