Skip to content

Commit cebaeeb

Browse files
authored
docs: more details and cleanup (#146)
1 parent e99cda5 commit cebaeeb

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ I have made a long blog post explaining the philosophy behind and how to use it:
1818

1919
* [Introducing the MicroSymfony application template](https://www.strangebuzz.com/en/blog/introducing-the-microsymfony-application-template)
2020

21-
If you want to use the last Symfony **6.4 LTS** version in your `composer.json`
21+
One rule: the only mandatory dependency is **PHP**!
22+
23+
> **PS**: If you want to use the last Symfony **6.4 LTS** version in your `composer.json`
2224
file, replace all occurrences of `7.2` with `6.4` and run `composer up`.
2325

2426

2527
## Table of Contents 📖
2628

27-
* [About](#about-)
2829
* [Demos](#demos-)
2930
* [Quick-start](#quick-start-)
3031
* [With the Symfony binary](#with-the-symfony-binary-)
@@ -38,11 +39,13 @@ file, replace all occurrences of `7.2` with `6.4` and run `composer up`.
3839
* [Database](#database-)
3940
* [Tooling](#tooling-)
4041
* [Notes](#notes-)
42+
* [Symfony UX](#symfony-ux)
43+
* [PHP configuration files](#php-configuration-files)
4144
* [Other good practices](#other-good-practices-)
4245
* [References](#references-)
4346
* [Contributing](#contributing-)
44-
* [Security](#contributing-)
45-
* [Credits](#contributing-)
47+
* [Security](#security-)
48+
* [Credits](#credits-)
4649
* [License](#license-)
4750
* [Built with MicroSymfony](#built-with-microsymfony-)
4851

@@ -62,7 +65,7 @@ Because a live demo is always better than all explanations:
6265
You must have the [Symfony binary](https://symfony.com/download#step-1-install-symfony-cli)
6366
and [composer](https://getcomposer.org/) installed locally.
6467

65-
To create a new project from the GitHub template, run:
68+
To create a new project, from the last tag, run:
6669

6770
composer create-project strangebuzz/microsymfony && cd microsymfony
6871

@@ -76,6 +79,12 @@ Or with Castor:
7679

7780
Open [https://127.0.0.1:8000](https://127.0.0.1:8000) (considering your 8000 port is free) and enjoy! 🙂
7881

82+
> **PS**: You can also use the green button "[Use this template ⇩](https://github.com/new?template_name=MicroSymfony&template_owner=strangebuzz)"
83+
at the top right of the GitHub project homepage.
84+
This creates a new repository from the main branch instead of the last release.
85+
I guarantee that all commits on the main are stable; you can verify that the associated
86+
CI jobs are ✅.
87+
7988

8089
### With FrankenPHP 🧟‍
8190

@@ -180,7 +189,7 @@ Then clone the `eloquent` branch, and run `composer install && make load-fixture
180189
These « database » branches aim to display a list of records from a [SQLite](https://www.sqlite.org/)
181190
database.
182191

183-
* Doctrine DBAL ([PR](https://github.com/strangebuzz/MicroSymfony/pull/72), [branch](https://github.com/strangebuzz/MicroSymfony/tree/doctrine-dbal), rebased on 2024-11-17)
192+
* Doctrine DBAL ([PR](https://github.com/strangebuzz/MicroSymfony/pull/72), [branch](https://github.com/strangebuzz/MicroSymfony/tree/doctrine-dbal), rebased on 2024-12-22)
184193
* Eloquent ORM ([PR](https://github.com/strangebuzz/MicroSymfony/pull/65), [branch](https://github.com/strangebuzz/MicroSymfony/tree/eloquent), rebased on 2024-11-17)
185194

186195
### Tooling 🔨
@@ -217,7 +226,7 @@ run:
217226

218227
* Using PHP configuration files instead of YAML ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/config/services.php))
219228
* Using strict types in all PHP files ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/src/Controller/SlugifyAction.php#L3))
220-
* Using the ADR pattern in an action controller ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/src/Controller/SlugifyAction.php)) ([doc](https://symfony.com/doc/current/controller/service.html#invokable-controllers))
229+
* Using the ADR pattern in an action controller ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/src/Controller/HomeAction.php)) ([doc](https://symfony.com/doc/current/controller/service.html#invokable-controllers))
221230
* The [composer.json](https://github.com/strangebuzz/MicroSymfony/blob/main/composer.json)
222231
file is normalized with [ergebnis/composer-normalize](https://github.com/ergebnis/composer-normalize)
223232
* Use of the [composer bin plugin](https://github.com/bamarni/composer-bin-plugin)
@@ -255,7 +264,7 @@ Please see [SECURITY](https://github.com/strangebuzz/MicroSymfony/blob/main/SECU
255264

256265
## Credits 🙏
257266

258-
* [COil](https://github.com/COil) (main maintainer)
267+
* [COil](https://github.com/COil) (primary maintainer)
259268
* [All Contributors](https://github.com/strangebuzz/MicroSymfony/graphs/contributors)
260269

261270

0 commit comments

Comments
 (0)