From e1de258b45bb85e3a3b6ec32ad1874e338ef4d73 Mon Sep 17 00:00:00 2001 From: Marco Polichetti Date: Wed, 5 Jul 2023 09:28:07 +0200 Subject: [PATCH] =?UTF-8?q?chore(docs):=20Improve=20README=20=F0=9F=93=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c491183..2e78a8b 100644 --- a/README.md +++ b/README.md @@ -25,28 +25,27 @@ > **Warning**: this project is still under development, please use it for testing purposes and feel free to suggest changes and improvements. -This project draws inspiration from the work of [dunglas/symfony-docker](https://github.com/dunglas/symfony-docker). Its goal is to provide a configurable environment and enhanced **developer experience**. It includes support for **Visual Studio Code Dev Containers**, **MariaDB** and **Webpack Encore**. Versions without database, production configuration and Visual Studio Code settings and extensions are also available! +This project draws inspiration from the work of [dunglas/symfony-docker](https://github.com/dunglas/symfony-docker). Its goal is to provide a configurable environment and enhanced **developer experience**. It includes support for **Visual Studio Code Dev Containers**, **MariaDB** and **Webpack Encore**. 💫 Main **features**: - ✅ Fully customizable - - Sensible defaults are provided for a configuration-less startup - - Utilize the existing `.env.local` file that you are already familiar with + - Sensible defaults for configuration-less startup + - Utilize the `.env.local` file you are already familiar with - ✅ Visual Studio Code [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) support - - Open multiple projects simultaneously with automatic port forwarding - - Includes opinionated settings and extensions - - Version without settings and extensions is also available + - Run multiple projects simultaneously with automatic port forwarding + - Opinionated settings and extensions - ✅ [MariaDB](https://mariadb.com/products/community-server) DBMS - - Doctrine `DATABASE_URL` parsing, promoting DRY principle + - Doctrine `DATABASE_URL` parsing for DRY principle - Doctrine migrations support - - Version without MariaDB service is also available - ✅ Production-ready, automatic HTTPS, HTTP/2 and [Vulcain](https://vulcain.rocks) support - - Automatic www redirection to non-www version - - Version without production configuration is also available + - Automatic www to non-www redirection - ✅ [Webpack Encore](https://github.com/symfony/webpack-encore) support - ✅ PHP OPcache [preloading](https://www.php.net/manual/en/opcache.preloading.php) support - ✅ Docker multi-platform images - - Prebuilt base images for faster project startup + - Prebuilt base images for faster startup + +Versions without database, production configuration and Visual Studio Code settings and extensions are also available!