Docs README
Summary: - Docs: README Stats: - 1 file changed, 29 insertions(+), 41 deletions(-)
This commit is contained in:
parent
76ebbd204e
commit
6f72f06b8f
68
README.md
68
README.md
@ -16,63 +16,51 @@ StorageRouter (main entry point)
|
|||||||
```
|
```
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
|
%%{init: {'theme': 'base', 'themeVariables': { 'fontSize': '16px', 'primaryColor': '#ffffff', 'lineColor': '#000000', 'textColor': '#000000', 'mainBkg': '#ffffff', 'nodeBorder': '#000000' }}}%%
|
||||||
flowchart TD
|
flowchart TD
|
||||||
%% Main Architecture Stack
|
%% Vertical Flow
|
||||||
App(["📱 <b>APP / FEATURE LAYER</b>"])
|
App(("📱 <b>APP / FEATURE</b>"))
|
||||||
|
|
||||||
|
SR["🔀 <b>STORAGE ROUTER</b><br/>(The Central Engine)"]
|
||||||
|
|
||||||
subgraph Config ["⚙️ GLOBAL CONFIGURATION"]
|
subgraph Config ["⚙️ GLOBAL CONFIGURATION"]
|
||||||
direction LR
|
direction TB
|
||||||
SC["StorageConfig"]
|
C1["Encryption & Sync Config"]
|
||||||
EC["EncryptionConfig"]
|
C2["App Group & File Config"]
|
||||||
FC["FileStorageConfig"]
|
|
||||||
SYC["SyncConfig"]
|
|
||||||
end
|
end
|
||||||
|
|
||||||
SR["🔀 <b>STORAGE ROUTER</b><br/>(Migration & Orchestration Engine)"]
|
|
||||||
|
|
||||||
subgraph Helpers ["🛠️ INTERNAL HELPER ACTORS"]
|
subgraph Helpers ["🛠️ INTERNAL HELPER ACTORS"]
|
||||||
direction TB
|
direction TB
|
||||||
subgraph Logic ["Core Logic"]
|
H1["Keychain & File Storage Helpers"]
|
||||||
direction LR
|
H2["UserDefaults & Sync Helpers"]
|
||||||
KH["KeychainHelper"]
|
H3["🔐 Encryption Service"]
|
||||||
FH["FileHelper"]
|
|
||||||
UH["UserDefaultsHelper"]
|
|
||||||
end
|
|
||||||
EH["🔐 EncryptionHelper"]
|
|
||||||
SH["🔄 SyncHelper"]
|
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph Storage ["💾 HARDWARE STORAGE"]
|
subgraph Storage ["💾 HARDWARE STORAGE LAYER"]
|
||||||
direction LR
|
direction LR
|
||||||
KC[("🗝️ Keychain")]
|
S1[("🗝️ Keychain")]
|
||||||
FS[("📁 File System")]
|
S2[("📁 File System")]
|
||||||
UD[("⚙️ UserDefaults")]
|
S3[("⚙️ UserDefaults")]
|
||||||
WatchOS["⌚ Apple Watch"]
|
|
||||||
end
|
end
|
||||||
|
|
||||||
%% Flow Relationships
|
%% Relationships
|
||||||
App -->|StorageKey| SR
|
App -->|StorageKey| SR
|
||||||
SR -.->|Resolves| Config
|
SR -.->|Resolves| Config
|
||||||
|
SR ==>|1. Orchestrate| Helpers
|
||||||
|
Helpers ==>|2. Persist| Storage
|
||||||
|
|
||||||
SR ==>|1. Routing Logic| Helpers
|
%% Migration Loop
|
||||||
|
Storage -.->|<b>3. AUTOMATIC MIGRATION</b>| SR
|
||||||
|
|
||||||
KH --> KC
|
%% Explicit Styling for High Contrast
|
||||||
FH --> FS
|
style App fill:#ffffff,stroke:#000,stroke-width:3px
|
||||||
UH --> UD
|
style SR fill:#e1f5fe,stroke:#000,stroke-width:4px
|
||||||
SH -->|WatchConnectivity| WatchOS
|
style Config fill:#fffde7,stroke:#000,stroke-dasharray: 5 5
|
||||||
|
style Helpers fill:#f5f5f5,stroke:#000,stroke-width:2px
|
||||||
|
style Storage fill:#e8f5e9,stroke:#000,stroke-width:3px
|
||||||
|
|
||||||
KH --- EH
|
%% Link Styling
|
||||||
FH --- EH
|
linkStyle default stroke:#000,stroke-width:2px,color:#000
|
||||||
|
|
||||||
%% Migration Logic
|
|
||||||
Storage -.->|<b>2. AUTOMATIC MIGRATION</b>| SR
|
|
||||||
|
|
||||||
%% Styling
|
|
||||||
style App fill:#fff,stroke:#333,stroke-width:2px
|
|
||||||
style Config fill:#f9f9f9,stroke:#999,stroke-dasharray: 5 5
|
|
||||||
style SR fill:#e1f5fe,stroke:#01579b,stroke-width:3px
|
|
||||||
style Storage fill:#f0f7ff,stroke:#0052cc,stroke-width:2px
|
|
||||||
style Helpers fill:#fff,stroke:#666
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## What Ships in the Package
|
## What Ships in the Package
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user