Skip to content

Commit 659ab61

Browse files
committed
docs(README.md): update architecture diagram to use Mermaid syntax for better visualization and clarity
1 parent af06870 commit 659ab61

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,27 @@ The Tezos Key Generation API provides:
1919

2020
## Architecture
2121

22-
```
23-
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
24-
│ API Client │ │ Key Generation │ │ Redis Store │
25-
│ │◄──►│ Service │◄──►│ │
26-
│ (HTTP/REST) │ │ │ │ (Key Pools) │
27-
└─────────────────┘ └─────────────────┘ └─────────────────┘
28-
│ │ │
29-
│ │ │
30-
▼ ▼ ▼
31-
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
32-
│ Tezos RPC │ │ Remote Signer │ │ Metrics & │
33-
│ (Network) │ │ (Signatory) │ │ Monitoring │
34-
└─────────────────┘ └─────────────────┘ └─────────────────┘
22+
```mermaid
23+
graph TB
24+
A[API Client<br/>HTTP/REST] --> B[Key Generation Service]
25+
B --> C[Redis Store<br/>Key Pools]
26+
27+
B --> D[Tezos RPC<br/>Network]
28+
B --> E[Remote Signer<br/>Signatory]
29+
B --> F[Metrics & Monitoring]
30+
31+
A -.->|HTTP Requests| B
32+
B -.->|Store/Retrieve Keys| C
33+
B -.->|Network Operations| D
34+
B -.->|Sign Transactions| E
35+
B -.->|Collect Metrics| F
36+
37+
style A fill:#e1f5fe
38+
style B fill:#f3e5f5
39+
style C fill:#e8f5e8
40+
style D fill:#fff3e0
41+
style E fill:#fce4ec
42+
style F fill:#f1f8e9
3543
```
3644

3745
## Quick Start

0 commit comments

Comments
 (0)