Docs README

Summary:
- Docs: README

Stats:
- 1 file changed, 41 insertions(+), 24 deletions(-)
This commit is contained in:
Matt Bruce 2026-01-14 17:50:08 -06:00
parent 27ddca9593
commit c2d37f9ab2

View File

@ -16,43 +16,60 @@ StorageRouter (main entry point)
``` ```
```mermaid ```mermaid
graph TD flowchart TD
App[App / Feature] -->|StorageKey| SR[StorageRouter] %% Node Definitions
App["📱 App / Feature"]
SR["🔀 StorageRouter"]
subgraph Config [Global Configuration] subgraph Config ["⚙️ Global Config"]
SC[StorageConfiguration] direction TB
EC[EncryptionConfiguration] SC["StorageConfiguration"]
FC[FileStorageConfiguration] EC["EncryptionConfiguration"]
SYC[SyncConfiguration] FC["FileStorageConfiguration"]
SYC["SyncConfiguration"]
end end
SR -.->|Resolves Defaults| Config subgraph Helpers ["🛠️ Internal Helpers"]
KH["KeychainHelper"]
FH["FileStorageHelper"]
UH["UserDefaultsHelper"]
EH["🔐 EncryptionHelper"]
SH["SyncHelper"]
end
SR -->|1. Check Migration| SR subgraph Storage ["💾 Hardware Storage"]
SR -->|2. Get/Set| KH[KeychainHelper] KC[("🗝️ Keychain")]
SR -->|2. Get/Set| FH[FileStorageHelper] FS[("📁 File System")]
SR -->|2. Get/Set| UH[UserDefaultsHelper] UD[("⚙️ UserDefaults")]
end
KH --- EH[EncryptionHelper] %% 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 FH --- EH
SR -->|Syncs| SH[SyncHelper]
subgraph Storage [Hardware Storage]
KC[(Keychain)]
FS[(File System)]
UD[(UserDefaults)]
end
KH --> KC KH --> KC
FH --> FS FH --> FS
UH --> UD UH --> UD
SH -->|WatchConnectivity| WatchOS[Apple Watch] SH -->|WatchConnectivity| WatchOS["⌚ Apple Watch"]
%% Migration flows %% Migration
UD -.->|Migrate| SR UD -.->|Migrate| SR
KC -.->|Migrate| SR KC -.->|Migrate| SR
FS -.->|Migrate| SR FS -.->|Migrate| 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
``` ```
## What Ships in the Package ## What Ships in the Package