Skip to content

Commit 3c6b78f

Browse files
committed
docs: update README structure and documentation links
1 parent b88938d commit 3c6b78f

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ security:
4343
ROLE_CONSOLE_DEBUG: ROLE_USER
4444
```
4545
46+
## Requirements
47+
48+
- PHP `>=8.1` (<8.6); **Symfony 8.0** and **8.1** require **PHP 8.4+**
49+
- Symfony **7.4**, **8.0**, or **8.1** (minimum supported minors; also works on Symfony 6.x and 7.0–7.3 via `composer.json` constraints)
50+
- `symfony/security-bundle` (or equivalent) in your application for role-based gates
51+
4652
## Configuration
4753

4854
```yaml
@@ -87,6 +93,26 @@ Same behaviour as Symfony's native `dump`, but output goes to the browser consol
8793

8894
When called empty, the label is `twig context` and the template name/line is used as the source location.
8995

96+
## Demo
97+
98+
- `demo/symfony7` — Symfony **7.4**, host port **8010** by default (`PORT` in `.env`)
99+
- `demo/symfony8` — Symfony **8.1** (PHP **8.5**), host port **8011** by default
100+
101+
Each demo runs **FrankenPHP + Caddy** in Docker (`FRANKENPHP_MODE=worker` by default). Login as `debugger / debug` and visit `/debug` to see `cdbg()` in the browser console. See [docs/DEMO-FRANKENPHP.md](docs/DEMO-FRANKENPHP.md).
102+
103+
Global demo commands: `make -C demo help` (e.g. `make -C demo up-symfony8`).
104+
105+
## Development
106+
107+
```bash
108+
make up
109+
make install
110+
make test
111+
make cs-check
112+
make phpstan
113+
make release-check
114+
```
115+
90116
## Documentation
91117

92118
- [Installation](docs/INSTALLATION.md)
@@ -108,32 +134,6 @@ When called empty, the label is `twig context` and the template name/line is use
108134
- [Demo (FrankenPHP)](docs/DEMO-FRANKENPHP.md)
109135
- [GitHub CI notes](docs/GITHUB_CI.md)
110136

111-
## Requirements
112-
113-
- PHP `>=8.1` (<8.6); **Symfony 8.0** and **8.1** require **PHP 8.4+**
114-
- Symfony **7.4**, **8.0**, or **8.1** (minimum supported minors; also works on Symfony 6.x and 7.0–7.3 via `composer.json` constraints)
115-
- `symfony/security-bundle` (or equivalent) in your application for role-based gates
116-
117-
## Development
118-
119-
```bash
120-
make up
121-
make install
122-
make test
123-
make cs-check
124-
make phpstan
125-
make release-check
126-
```
127-
128-
## Demo
129-
130-
- `demo/symfony7` — Symfony **7.4**, host port **8010** by default (`PORT` in `.env`)
131-
- `demo/symfony8` — Symfony **8.1** (PHP **8.5**), host port **8011** by default
132-
133-
Each demo runs **FrankenPHP + Caddy** in Docker (`FRANKENPHP_MODE=worker` by default). Login as `debugger / debug` and visit `/debug` to see `cdbg()` in the browser console. See [docs/DEMO-FRANKENPHP.md](docs/DEMO-FRANKENPHP.md).
134-
135-
Global demo commands: `make -C demo help` (e.g. `make -C demo up-symfony8`).
136-
137137
## Tests and coverage
138138

139139
- Tests: PHPUnit (PHP)

0 commit comments

Comments
 (0)