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, 30 insertions(+), 46 deletions(-)
This commit is contained in:
Matt Bruce 2026-01-14 17:52:14 -06:00
parent c2d37f9ab2
commit 5b13a8b377
1 changed files with 31 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -17,59 +17,43 @@ StorageRouter (main entry point)
```mermaid ```mermaid
flowchart TD flowchart TD
%% Node Definitions %% Vertical Stack Architecture
App["📱 App / Feature"] App(["<br/>📱 <b>APP / FEATURE LAYER</b><br/>"])
SR["🔀 StorageRouter"]
subgraph Config ["⚙️ Global Config"] Config["<br/>⚙️ <b>GLOBAL CONFIGURATION</b><br/>Encryption, Sync, & App Group IDs<br/>"]
SR["<br/>🔀 <b>STORAGE ROUTER</b><br/>(Migration & Orchestration Engine)<br/>"]
subgraph Helpers ["🛠️ <b>INTERNAL HELPER ACTORS</b>"]
direction TB direction TB
SC["StorageConfiguration"] KH["Keychain & File Helpers"]
EC["EncryptionConfiguration"] UH["UserDefaults & Sync Helpers"]
FC["FileStorageConfiguration"] EH["🔐 Encryption Service"]
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")]
end end
%% Flow subgraph Storage ["💾 <b>HARDWARE STORAGE</b>"]
App -->|StorageKey| SR direction TB
SR --> SR KC[("🗝️ SECURE KEYCHAIN")]
SR -.->|Resolves| Config FS[("📁 LOCAL FILE SYSTEM")]
UD[("⚙️ USER DEFAULTS")]
SR ==>|2. Get/Set| KH end
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"]
%% Migration %% Main Flow
UD -.->|Migrate| SR App -->|StorageKey| Config
KC -.->|Migrate| SR Config --> SR
FS -.->|Migrate| SR
SR ==>|1. Routing Logic| Helpers
Helpers ==>|2. Persistence| Storage
%% Migration Loop
Storage -.->|<b>3. AUTOMATIC MIGRATION</b>| SR
%% Styling %% Styling for Legibility
style Config fill:#f9f9f9,stroke:#ddd,stroke-dasharray: 5 5 style App fill:#fff,stroke:#333,stroke-width:2px
style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:2px style Config fill:#fff,stroke:#333,stroke-dasharray: 5 5
style SR fill:#e1f5fe,stroke:#01579b,stroke-width:2px 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 ## What Ships in the Package