From 35448d191baab796622e95ef23003e1b16bbb776 Mon Sep 17 00:00:00 2001 From: Matt Bruce Date: Wed, 14 Jan 2026 17:52:14 -0600 Subject: [PATCH] Docs: update docs for README Summary: - Docs: update docs for README Stats: - 1 file changed, 30 insertions(+), 46 deletions(-) --- README.md | 78 ++++++++++++++++++++++--------------------------------- 1 file changed, 31 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 1dae276..ed16603 100644 --- a/README.md +++ b/README.md @@ -17,59 +17,43 @@ StorageRouter (main entry point) ```mermaid flowchart TD - %% Node Definitions - App["📱 App / Feature"] - SR["🔀 StorageRouter"] + %% Vertical Stack Architecture + App(["
📱 APP / FEATURE LAYER
"]) - subgraph Config ["⚙️ Global Config"] + Config["
⚙️ GLOBAL CONFIGURATION
Encryption, Sync, & App Group IDs
"] + + SR["
🔀 STORAGE ROUTER
(Migration & Orchestration Engine)
"] + + subgraph Helpers ["🛠️ INTERNAL HELPER ACTORS"] direction TB - SC["StorageConfiguration"] - EC["EncryptionConfiguration"] - FC["FileStorageConfiguration"] - SYC["SyncConfiguration"] - end - - subgraph Helpers ["🛠️ Internal Helpers"] - KH["KeychainHelper"] - FH["FileStorageHelper"] - UH["UserDefaultsHelper"] - EH["🔐 EncryptionHelper"] - SH["SyncHelper"] - end - - subgraph Storage ["💾 Hardware Storage"] - KC[("🗝️ Keychain")] - FS[("📁 File System")] - UD[("⚙️ UserDefaults")] + KH["Keychain & File Helpers"] + UH["UserDefaults & Sync Helpers"] + EH["🔐 Encryption Service"] end - %% Flow - App -->|StorageKey| SR - SR --> SR - SR -.->|Resolves| Config - - SR ==>|2. Get/Set| KH - SR ==>|2. Get/Set| FH - SR ==>|2. Get/Set| UH - SR ==>|Syncs| SH - - KH --- EH - FH --- EH - - KH --> KC - FH --> FS - UH --> UD - SH -->|WatchConnectivity| WatchOS["⌚ Apple Watch"] + subgraph Storage ["💾 HARDWARE STORAGE"] + direction TB + KC[("🗝️ SECURE KEYCHAIN")] + FS[("📁 LOCAL FILE SYSTEM")] + UD[("⚙️ USER DEFAULTS")] + end - %% Migration - UD -.->|Migrate| SR - KC -.->|Migrate| SR - FS -.->|Migrate| SR + %% Main Flow + App -->|StorageKey| Config + Config --> SR + + SR ==>|1. Routing Logic| Helpers + Helpers ==>|2. Persistence| Storage + + %% Migration Loop + Storage -.->|3. AUTOMATIC MIGRATION| SR - %% Styling - style Config fill:#f9f9f9,stroke:#ddd,stroke-dasharray: 5 5 - style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:2px - style SR fill:#e1f5fe,stroke:#01579b,stroke-width:2px + %% Styling for Legibility + 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 ``` ## What Ships in the Package