From 35611fcc5fc9fb775d98c55358c0d98ef89dbbb5 Mon Sep 17 00:00:00 2001
From: Marc Wolf <kontakt@marcit.eu>
Date: Tue, 11 Jun 2024 15:29:47 +0200
Subject: [PATCH] [TASK] Update README.md

---
 .github/workflows/docker-compose-test.yml |  2 +-
 README.md                                 | 47 ++++++++++++++++++++++-
 2 files changed, 47 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/docker-compose-test.yml b/.github/workflows/docker-compose-test.yml
index f385ca6..45381ec 100644
--- a/.github/workflows/docker-compose-test.yml
+++ b/.github/workflows/docker-compose-test.yml
@@ -46,7 +46,7 @@ jobs:
 
             - name: Run PHPUnit tests
               run: |
-                  docker-compose exec -T php-fpm ./vendor/bin/phpunit tests --colors
+                  docker-compose exec -T php-fpm ./vendor/bin/phpunit tests
 
             - name: Test Redis
               run: |
diff --git a/README.md b/README.md
index 9df80cb..51eddd3 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
 # Docker compose PHP 8.3.8, Xdebug 3.4.0, Nginx 1.27.0, Redis 7.2.5 and MariaDB 11.4.2
 
 ![docker](https://img.shields.io/badge/Docker-compose-brightgreen.svg)
+![nginx](https://img.shields.io/badge/nginx-1.27.0-brightgreen.svg)
 ![php](https://img.shields.io/badge/PHP_FPM-8.3.8-brightgreen.svg)
 ![xdebug](https://img.shields.io/badge/Xdebug-3.3.2-brightgreen.svg)
-![nginx](https://img.shields.io/badge/nginx-1.27.0-brightgreen.svg)
+![phpunit](https://img.shields.io/badge/PHPUnit-11.2.1-brightgreen.svg)
 ![redis](https://img.shields.io/badge/Redis-7.2.5-brightgreen.svg)
 ![mariadb](https://img.shields.io/badge/MariaDB-11.4.2-brightgreen.svg)
 
@@ -12,8 +13,52 @@
 * And [composer the dependency manager for PHP](https://getcomposer.org) to start easy your project
 * Built on the lightweight [nginx 1.27.0](https://nginx.org) webserver
 * Debugging with [Xdebug 3.3.2](https://xdebug.org)
+* Testing with [PHPUnit 11.2.1](https://phpunit.de) to ensure code quality and reliability
 * [Redis 7.2.5](https://redis.io) as session storage, database, cache, streaming engine, and message broker
 * Database storage with [MariaDB 11.4.2](https://mariadb.org)
 
+## Setup Instructions
+
+1. **Clone the repository:**
+   ```sh
+   git clone https://github.com/IshtarStar/docker-compose-nginx-phpfpm-xdebug-mariadb.git ./docker-skeleton
+   cd docker-skeleton
+   ```
+
+2. **Build and start the Docker containers:**
+   ```sh
+   docker-compose up --build -d
+   ```
+
+3. **Install Composer dependencies:**
+   ```sh
+   docker-compose exec -T php-fpm composer install
+   ```
+
+4. **Run PHPUnit tests:**
+   ```sh
+   docker-compose exec -T php-fpm ./vendor/bin/phpunit tests
+   ```
+
+## Example PHPUnit Test
+
+An example PHPUnit test is included in the `tests` directory:
+
+```php
+// tests/ExampleTest.php
+
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class ExampleTest extends TestCase
+{
+    public function testExample()
+    {
+        $this->assertTrue(true);
+    }
+}
+```
+
 See also:
 [Blog-Post: Dockerize your PHP application with Nginx and PHP8 FPM](https://marc.it/dockerize-application-with-nginx-and-php8/)