From 76ebbd204e7641f013169d006a16fed59df6035f Mon Sep 17 00:00:00 2001 From: Matt Bruce Date: Wed, 14 Jan 2026 17:54:10 -0600 Subject: [PATCH] Docs README Summary: - Docs: README Stats: - 1 file changed, 43 insertions(+), 24 deletions(-) --- README.md | 71 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 45 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index ed16603..1bfc685 100644 --- a/README.md +++ b/README.md @@ -17,43 +17,62 @@ StorageRouter (main entry point) ```mermaid flowchart TD - %% Vertical Stack Architecture - App(["
📱 APP / FEATURE LAYER
"]) + %% Main Architecture Stack + App(["📱 APP / FEATURE LAYER"]) - Config["
⚙️ GLOBAL CONFIGURATION
Encryption, Sync, & App Group IDs
"] - - SR["
🔀 STORAGE ROUTER
(Migration & Orchestration Engine)
"] - - subgraph Helpers ["🛠️ INTERNAL HELPER ACTORS"] - direction TB - KH["Keychain & File Helpers"] - UH["UserDefaults & Sync Helpers"] - EH["🔐 Encryption Service"] + subgraph Config ["⚙️ GLOBAL CONFIGURATION"] + direction LR + SC["StorageConfig"] + EC["EncryptionConfig"] + FC["FileStorageConfig"] + SYC["SyncConfig"] end - subgraph Storage ["💾 HARDWARE STORAGE"] + SR["🔀 STORAGE ROUTER
(Migration & Orchestration Engine)"] + + subgraph Helpers ["🛠️ INTERNAL HELPER ACTORS"] direction TB - KC[("🗝️ SECURE KEYCHAIN")] - FS[("📁 LOCAL FILE SYSTEM")] - UD[("⚙️ USER DEFAULTS")] + subgraph Logic ["Core Logic"] + direction LR + KH["KeychainHelper"] + FH["FileHelper"] + UH["UserDefaultsHelper"] + end + EH["🔐 EncryptionHelper"] + SH["🔄 SyncHelper"] end - %% Main Flow - App -->|StorageKey| Config - Config --> SR + subgraph Storage ["💾 HARDWARE STORAGE"] + direction LR + KC[("🗝️ Keychain")] + FS[("📁 File System")] + UD[("⚙️ UserDefaults")] + WatchOS["⌚ Apple Watch"] + end + + %% Flow Relationships + App -->|StorageKey| SR + SR -.->|Resolves| Config SR ==>|1. Routing Logic| Helpers - Helpers ==>|2. Persistence| Storage - %% Migration Loop - Storage -.->|3. AUTOMATIC MIGRATION| SR + KH --> KC + FH --> FS + UH --> UD + SH -->|WatchConnectivity| WatchOS + + KH --- EH + FH --- EH - %% Styling for Legibility + %% Migration Logic + Storage -.->|2. AUTOMATIC MIGRATION| SR + + %% Styling style App fill:#fff,stroke:#333,stroke-width:2px - style Config fill:#fff,stroke:#333,stroke-dasharray: 5 5 - style SR fill:#e1f5fe,stroke:#01579b,stroke-width:4px - style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:3px - style Helpers fill:#f9f9f9,stroke:#666,stroke-width:2px + style Config fill:#f9f9f9,stroke:#999,stroke-dasharray: 5 5 + style SR fill:#e1f5fe,stroke:#01579b,stroke-width:3px + style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:2px + style Helpers fill:#fff,stroke:#666 ``` ## What Ships in the Package