add mermaid diagrams

neuroforgede · Nov 12, 2023 · dd77040 · dd77040
1 parent 1780df5
commit dd77040
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,18 @@ This is done by filtering all requests on resource labels to check whether the r
 
 This projects uses Node.js and Express for the server, along with the dockerode (and docker-modem) library to interact with Docker.
 
+```mermaid
+sequenceDiagram
+    participant User as Tenant User
+    participant Proxy as Tenant Proxy
+    participant Swarm as Docker Swarm
+
+    User->>+Proxy: Sends Docker Commands
+    Proxy->>+Swarm: Filters & Forwards Commands
+    Swarm-->>-Proxy: Returns Results
+    Proxy-->>-User: Shows Filtered Results
+```
+
 ## ⭐ Features
 
 - Multi-tenant Access Control: Restricts access to Docker Swarm resources based on ownership labels.