Mastodon
/
mastodon-app-ufficiale-iphone-ios
mirror of https://github.com/mastodon/mastodon-ios.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: write some lines for doc

This commit is contained in:
CMK 2022-07-01 13:40:57 +08:00
parent 3aa5eaf9a7
commit 938af7c571
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/How-it-works.md
View File

@ -1,14 +1,28 @@
# How it works # How it works
TBD App is currently build for iOS and iPadOS. We use the MVVM architecture to construct the whole app.
## Targets
The app build with those targets:
- Mastodon: the app itself
- NotificationService: E2E push notification service
- ShareActionExtension: iOS share action
- MastodonIntent: Siri shortcuts
- AppShared: used for `cocoapods-keys` integration
## MastodonSDK ## MastodonSDK
This is a Swift Pacakge contains the common libraries to build this app. There is a self-hosted Swift Pacakge contains the common libraries to build this app.
- CoreDataStack: Core Data model definition and util methods - CoreDataStack: Core Data model definition and util methods
- MastodonAsset: image and font assets - MastodonAsset: image and font assets
- MastodonCommon: store App Group ID - MastodonCommon: store App Group ID
- MastodonExtension: system API extension - MastodonExtension: system API extension utility
- MastodonLocalization: i18n resources - MastodonLocalization: i18n resources
- MastodonSDK: Mastodon API client - MastodonSDK: Mastodon API client
- MastodonUI: App UI components - MastodonUI: App UI components
Some brief for important packets:
#### CoreDataStack
// TODO: