Update README + docs
Summary: - Docs: README - Assets: Assets Stats: - 2 files changed, 36 insertions(+)
This commit is contained in:
parent
371a5e2f54
commit
b5f8c414cd
BIN
Assets/architecture_diagram.png
Normal file
BIN
Assets/architecture_diagram.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 244 KiB |
36
README.md
36
README.md
@ -15,6 +15,42 @@ StorageRouter (main entry point)
|
|||||||
└── SyncHelper
|
└── SyncHelper
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
```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
|
## What Ships in the Package
|
||||||
|
|
||||||
### Protocols
|
### Protocols
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user