From dff614aee6ba81c41fe9721936d7bf6cfb9c1b90 Mon Sep 17 00:00:00 2001
From: Fabrice Lecomte <fabrice.lecomte.be@gmail.com>
Date: Tue, 15 Apr 2025 20:37:24 +0200
Subject: [PATCH] doc: Add "What's the demo for ?" section to the documentation

---
 README.md           | 37 +++++++++++++------------------------
 doc/installation.md | 23 +++++++++++++++++++++++
 2 files changed, 36 insertions(+), 24 deletions(-)
 create mode 100644 doc/installation.md

diff --git a/README.md b/README.md
index c837438..7ae80ab 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,21 @@
-Event demo
+Event Demo
 ==========
-- [Installation](#installation)
+- [Installation](./doc/installation.md)
+- [What's the demo for ?](#whats-the-demo-for-)
 - [What's in this demo](#whats-in-this-demo)
+- [The stack](#the-stack)
 
 
-Installation
-------------
+What's the demo for ?
+--------------------
 
-To run the stack:
+This demo is intended to demonstrate the implementation 
+of different patterns and architectures.
 
-```shell
-docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
-```
-
-Api url:
-- [Backend API](http://api.traefik.me/)
-- [Frontend web site](http://app.traefik.me/) (WIP)
-
-Exposed url on test env:
-- [PostgreSql](http://localhost:5432/)
-- [Redis](http://localhost:6379/)
-- [RabbitMQ](http://localhost:15672/)
-
-Admin service URL:
-- [Træfik dashboard](http://traefik.traefik.me/)
-- [Redis insight](http://insight.redis.traefik.me/)
-- [pgAdmin](http://pgadmin.postgresql.traefik.me/)
-- [RabbitMQ management](http://management.rabbitmq.traefik.me/)
+- The Event sourcing pattern.
+- The Event driver pattern.
+- The CQRS pattern.
+- With the Hexagonal architecture.
 
 
 What's in this demo
@@ -59,7 +48,7 @@ The stack
 Language
 - Kotlin
 
-Framwork
+Framework
 - Ktor
 
 Database
diff --git a/doc/installation.md b/doc/installation.md
new file mode 100644
index 0000000..0fced39
--- /dev/null
+++ b/doc/installation.md
@@ -0,0 +1,23 @@
+Installation
+============
+
+To run the stack:
+
+```shell
+docker compose -f docker\docker-compose-prod.yaml -p event-demo up -d
+```
+
+Api url:
+- [Backend API](http://api.traefik.me/)
+- [Frontend web site](http://app.traefik.me/) (WIP)
+
+Exposed url on test env:
+- [PostgreSql](http://localhost:5432/)
+- [Redis](http://localhost:6379/)
+- [RabbitMQ](http://localhost:15672/)
+
+Admin service URL:
+- [Træfik dashboard](http://traefik.traefik.me/)
+- [Redis insight](http://insight.redis.traefik.me/)
+- [pgAdmin](http://pgadmin.postgresql.traefik.me/)
+- [RabbitMQ management](http://management.rabbitmq.traefik.me/)
\ No newline at end of file