Update README + docs

Summary:
- Docs: README
- Assets: Assets

Stats:
- 2 files changed, 36 insertions(+)
This commit is contained in:
Matt Bruce 2026-01-14 13:57:23 -06:00
parent 371a5e2f54
commit b5f8c414cd
2 changed files with 36 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 244 KiB

View File

@ -15,6 +15,42 @@ StorageRouter (main entry point)
└── SyncHelper
```
![LocalData Architecture](Assets/architecture_diagram.png)
```mermaid
graph TD
App[App / Feature] -->|StorageKey| SR[StorageRouter]
subgraph Config [Global Configuration]
SC[StorageConfiguration]
EC[EncryptionConfiguration]
FC[FileStorageConfiguration]
SYC[SyncConfiguration]
end
SR -.->|Resolves Defaults| Config
SR -->|Delegates| KH[KeychainHelper]
SR -->|Delegates| FH[FileStorageHelper]
SR -->|Delegates| UH[UserDefaultsHelper]
KH --- EH[EncryptionHelper]
FH --- EH
SR -->|Syncs| SH[SyncHelper]
subgraph Storage [Hardware Storage]
KC[(Keychain)]
FS[(File System)]
UD[(UserDefaults)]
end
KH --> KC
FH --> FS
UH --> UD
SH -->|WatchConnectivity| WatchOS[Apple Watch]
```
## What Ships in the Package
### Protocols