Docs README
Summary: - Docs: README Stats: - 1 file changed, 30 insertions(+), 46 deletions(-)
This commit is contained in:
parent
c2d37f9ab2
commit
5b13a8b377
72
README.md
72
README.md
@ -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
|
end
|
||||||
|
|
||||||
subgraph Helpers ["🛠️ Internal Helpers"]
|
subgraph Storage ["💾 <b>HARDWARE STORAGE</b>"]
|
||||||
KH["KeychainHelper"]
|
direction TB
|
||||||
FH["FileStorageHelper"]
|
KC[("🗝️ SECURE KEYCHAIN")]
|
||||||
UH["UserDefaultsHelper"]
|
FS[("📁 LOCAL FILE SYSTEM")]
|
||||||
EH["🔐 EncryptionHelper"]
|
UD[("⚙️ USER DEFAULTS")]
|
||||||
SH["SyncHelper"]
|
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph Storage ["💾 Hardware Storage"]
|
%% Main Flow
|
||||||
KC[("🗝️ Keychain")]
|
App -->|StorageKey| Config
|
||||||
FS[("📁 File System")]
|
Config --> SR
|
||||||
UD[("⚙️ UserDefaults")]
|
|
||||||
end
|
|
||||||
|
|
||||||
%% Flow
|
SR ==>|1. Routing Logic| Helpers
|
||||||
App -->|StorageKey| SR
|
Helpers ==>|2. Persistence| Storage
|
||||||
SR --> SR
|
|
||||||
SR -.->|Resolves| Config
|
|
||||||
|
|
||||||
SR ==>|2. Get/Set| KH
|
%% Migration Loop
|
||||||
SR ==>|2. Get/Set| FH
|
Storage -.->|<b>3. AUTOMATIC MIGRATION</b>| SR
|
||||||
SR ==>|2. Get/Set| UH
|
|
||||||
SR ==>|Syncs| SH
|
|
||||||
|
|
||||||
KH --- EH
|
%% Styling for Legibility
|
||||||
FH --- EH
|
style App fill:#fff,stroke:#333,stroke-width:2px
|
||||||
|
style Config fill:#fff,stroke:#333,stroke-dasharray: 5 5
|
||||||
KH --> KC
|
style SR fill:#e1f5fe,stroke:#01579b,stroke-width:4px
|
||||||
FH --> FS
|
style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:3px
|
||||||
UH --> UD
|
style Helpers fill:#f9f9f9,stroke:#666,stroke-width:2px
|
||||||
SH -->|WatchConnectivity| WatchOS["⌚ Apple Watch"]
|
|
||||||
|
|
||||||
%% Migration
|
|
||||||
UD -.->|Migrate| SR
|
|
||||||
KC -.->|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
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user