TopDogLabs/LocalData
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs README

Browse Source 
Summary:
- Docs: README

Stats:
- 1 file changed, 43 insertions(+), 24 deletions(-)
This commit is contained in:
Matt Bruce 2026-01-14 17:54:10 -06:00
parent 5b13a8b377
commit 76ebbd204e
1 changed files with 45 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -17,43 +17,62 @@ StorageRouter (main entry point)
```mermaid ```mermaid
flowchart TD flowchart TD
%% Vertical Stack Architecture %% Main Architecture Stack
App(["<br/>📱 <b>APP / FEATURE LAYER</b><br/>"]) App(["📱 <b>APP / FEATURE LAYER</b>"])
Config["<br/>⚙️ <b>GLOBAL CONFIGURATION</b><br/>Encryption, Sync, & App Group IDs<br/>"] subgraph Config ["⚙️ GLOBAL CONFIGURATION"]
direction LR
SR["<br/>🔀 <b>STORAGE ROUTER</b><br/>(Migration & Orchestration Engine)<br/>"] SC["StorageConfig"]
EC["EncryptionConfig"]
subgraph Helpers ["🛠️ <b>INTERNAL HELPER ACTORS</b>"] FC["FileStorageConfig"]
direction TB SYC["SyncConfig"]
KH["Keychain & File Helpers"]
UH["UserDefaults & Sync Helpers"]
EH["🔐 Encryption Service"]
end end
subgraph Storage ["💾 <b>HARDWARE STORAGE</b>"] SR["🔀 <b>STORAGE ROUTER</b><br/>(Migration & Orchestration Engine)"]
subgraph Helpers ["🛠️ INTERNAL HELPER ACTORS"]
direction TB direction TB
KC[("🗝️ SECURE KEYCHAIN")] subgraph Logic ["Core Logic"]
FS[("📁 LOCAL FILE SYSTEM")] direction LR
UD[("⚙️ USER DEFAULTS")] KH["KeychainHelper"]
FH["FileHelper"]
UH["UserDefaultsHelper"]
end
EH["🔐 EncryptionHelper"]
SH["🔄 SyncHelper"]
end end
%% Main Flow subgraph Storage ["💾 HARDWARE STORAGE"]
App -->|StorageKey| Config direction LR
Config --> SR KC[("🗝️ Keychain")]
FS[("📁 File System")]
UD[("⚙️ UserDefaults")]
WatchOS["⌚ Apple Watch"]
end
%% Flow Relationships
App -->|StorageKey| SR
SR -.->|Resolves| Config
SR ==>|1. Routing Logic| Helpers SR ==>|1. Routing Logic| Helpers
Helpers ==>|2. Persistence| Storage
%% Migration Loop KH --> KC
Storage -.->|<b>3. AUTOMATIC MIGRATION</b>| SR FH --> FS
UH --> UD
SH -->|WatchConnectivity| WatchOS
%% Styling for Legibility KH --- EH
FH --- EH
%% Migration Logic
Storage -.->|<b>2. AUTOMATIC MIGRATION</b>| SR
%% Styling
style App fill:#fff,stroke:#333,stroke-width:2px style App fill:#fff,stroke:#333,stroke-width:2px
style Config fill:#fff,stroke:#333,stroke-dasharray: 5 5 style Config fill:#f9f9f9,stroke:#999,stroke-dasharray: 5 5
style SR fill:#e1f5fe,stroke:#01579b,stroke-width:4px style SR fill:#e1f5fe,stroke:#01579b,stroke-width:3px
style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:3px style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:2px
style Helpers fill:#f9f9f9,stroke:#666,stroke-width:2px style Helpers fill:#fff,stroke:#666
``` ```
## What Ships in the Package ## What Ships in the Package