From 88548c055d558a05d013aa08bfa6f66cb11ffc9f Mon Sep 17 00:00:00 2001
From: FerroO2000 <30318301+FerroO2000@users.noreply.github.com>
Date: Wed, 24 Jul 2024 17:21:32 +0200
Subject: [PATCH] docs: add "dumb" model

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 49 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 0bc15fc..61ccc9a 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,58 @@
 [![Go Reference](https://pkg.go.dev/badge/github.com/squadracorsepolito/acmelib.svg)](https://pkg.go.dev/github.com/squadracorsepolito/acmelib)
 [![Go Report Card](https://goreportcard.com/badge/github.com/squadracorsepolito/acmelib)](https://goreportcard.com/report/github.com/squadracorsepolito/acmelib)
 
-> [!IMPORTANT]
-> Thi repo was moved to [squadracorse](https://github.com/squadracorsepolito/acmelib) organization.
-
 A [Golang](https://go.dev/) package for modelling complex CAN networks.
 
 The package documentation can be found [here](https://pkg.go.dev/github.com/FerroO2000/acmelib).
 
+## Model
+
+```mermaid
+flowchart
+    subgraph Network
+        bus(Bus)
+
+        subgraph Node
+            node-int(Node Interface)
+        end
+
+        message(Message)
+
+        subgraph Signal
+            std-sig(Standard Signal)
+            enum-sig(Enum Signal)
+            mux-sig(Multiplexer Signal)
+        end
+
+        sig-type(Signal Type)
+        sig-unit(Signal Unit)
+        sig-enum(Signal Enum)
+
+        attribute(Attribute)
+    end
+
+    bus --Attaches--o node-int
+
+    node-int --Sends--o message
+    message -.Receives.-o node-int
+
+    message --Contains--o Signal
+
+    std-sig --o sig-type
+    std-sig --o sig-unit
+
+    enum-sig --o sig-enum
+
+    mux-sig --o std-sig
+    mux-sig --o enum-sig
+    mux-sig --o mux-sig
+
+    attribute -.- bus
+    attribute -.- Node
+    attribute -.- message
+    attribute -.- Signal
+```
+
 ## Getting started
 
 ### Prerequisites
@@ -26,6 +71,4 @@ go get -u github.com/squadracorsepolito/acmelib
 
 ## TODOs
 
-- Adding examples
-- Adding JSON/Yaml and Protobuf parsing of the model
-- Improving test coverage
+-   Adding examples