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: add how it work guide

This commit is contained in:
CMK 2022-03-30 17:34:47 +08:00
parent abbcd30772
commit 3aa5eaf9a7
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/How-it-works.md Normal file
View File

@ -0,0 +1,14 @@
# How it works
TBD
## MastodonSDK
This is a Swift Pacakge contains the common libraries to build this app.
- CoreDataStack: Core Data model definition and util methods
- MastodonAsset: image and font assets
- MastodonCommon: store App Group ID
- MastodonExtension: system API extension
- MastodonLocalization: i18n resources
- MastodonSDK: Mastodon API client
- MastodonUI: App UI components

4
Documentation/Setup.md
View File

@ -59,7 +59,7 @@ open Mastodon.xcworkspace
The CocoaPods-Key plugin will request the push notification endpoint. You can fufill the empty string and set it later. To setup the push notification. Please check section `Push Notification` below.
The app requires the `App Group` capability. To make sure it works for your developer membership. Please check [AppSecret.swift](../AppShared/AppSecret.swift) file and set another unique `groupID` and update `App Group` settings.
The app requires the `App Group` capability. To make sure it works for your developer membership. Please check [AppSecret.swift](../AppShared/AppSecret.swift) and [AppName.swift](../MastodonSDK/Sources/MastodonCommon/AppName.swift) file and set another unique `groupID` and update `App Group` settings.
#### Push Notification (Optional)
The app is compatible with [toot-relay](https://github.com/DagAgren/toot-relay) APNs. You can set your push notification endpoint via Cocoapod-Keys. There are two endpoints:
@ -80,4 +80,4 @@ Please check and set the `notification.Topic` to the app BundleID in [toot-relay
## What's next
We welcome contributions! And if you have an interest to contribute codes. Here is a document that describes the app architecture and what's tech stack it uses.
We welcome contributions! And if you have an interest to contribute codes. [Here](./How-it-works.md) is a document that describes the app architecture and what's tech stack it uses.