Skip to content

Commit 3511d1f

Browse files
committed
Cleaned up readme
1 parent 494e561 commit 3511d1f

1 file changed

Lines changed: 40 additions & 17 deletions

File tree

README.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,43 @@
11
# itk-dev/entity-bundle
22

3-
Cross-cutting entity foundation for Symfony 7.4 / Doctrine ORM 3 projects.
3+
Cross-cutting entity foundation for Symfony 7.4 / 8.0 and Doctrine ORM 3 projects.
4+
5+
## Requirements
6+
7+
- PHP **>= 8.4**
8+
- Symfony **7.4 or 8.0** (`framework-bundle`, `security-bundle`, `clock`, `finder`, `uid`)
9+
- Doctrine ORM **^3.0** with `doctrine/doctrine-bundle` **^2.13 or ^3.0**
10+
- [`damienharper/auditor-bundle`](https://github.com/DamienHarper/auditor-bundle) **^6.3** (only relevant when `audit.enabled` is on)
11+
12+
## Installation
13+
14+
The bundle is not published on Packagist. Add it to a Symfony project as a Composer VCS repository:
15+
16+
```json
17+
{
18+
"repositories": [
19+
{ "type": "vcs", "url": "https://github.com/itk-dev/entity-bundle.git" }
20+
],
21+
"require": {
22+
"itk-dev/entity-bundle": "^1.0"
23+
}
24+
}
25+
```
26+
27+
Then:
28+
29+
```bash
30+
composer require itk-dev/entity-bundle:^1.0
31+
```
32+
33+
Enable the bundle in `config/bundles.php`:
34+
35+
```php
36+
return [
37+
// ...
38+
ITKDev\EntityBundle\ITKDevEntityBundle::class => ['all' => true],
39+
];
40+
```
441

542
## What you get
643

@@ -318,23 +355,9 @@ compile time and ships two console commands:
318355

319356
The mechanism is law-neutral; the same machinery applies to GDPR, CCPA, LGPD, PIPEDA, etc.
320357

321-
## Installation
322-
323-
```bash
324-
composer require itk-dev/entity-bundle
325-
```
326-
327-
Register the bundle (if not auto-registered):
328-
329-
```php
330-
// config/bundles.php
331-
return [
332-
// ...
333-
ITKDev\EntityBundle\ITKDevEntityBundle::class => ['all' => true],
334-
];
335-
```
358+
## Configuration
336359

337-
Configure (everything is optional — see the reference table below for defaults):
360+
Everything is optional — see the reference table below for defaults.
338361

339362
```yaml
340363
# config/packages/itk_dev_entity.yaml

0 commit comments

Comments
 (0)