From 68a955d8c2ac09fdb9835e5c665b97f61b21b828 Mon Sep 17 00:00:00 2001
From: Erwin Kramer <r3verse@gmail.com>
Date: Mon, 23 Dec 2024 19:32:14 +0100
Subject: [PATCH] add simple mermaid

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index 6e30ca4..a47ecc1 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,43 @@ The API complies to:
 
 - [REST Client extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) in Visual Studio Code for quick local tests via `.http` files
 
+## Design
+
+Technically, the design is layered like the following flowchart.
+
+```mermaid
+flowchart TB
+
+apis[BankApi.Service.Beta / BankApi.Service.Stable]
+aspire[BankApi.Orchestration]
+test[BankApi.Tests]
+
+infra_gen[Infra.Generated]
+specs_gen[Specs.Generated]
+specs_downstream[Specs.Downstream]
+
+subgraph core[BankApi.Core]
+Defaults
+DownstreamClients
+Implementation
+end
+
+specs_downstream -- .kiota --> DownstreamClients
+Defaults --> Implementation
+
+DownstreamClients --> Defaults
+DownstreamClients --> Implementation
+
+Defaults --> apis
+Implementation --> apis
+Implementation --> test
+
+apis --> aspire
+apis --> specs_gen
+
+aspire--> infra_gen
+```
+
 ## Prerequisites
 
 If not using the [Dev Container](.devcontainer/devcontainer.json), install: