From 3aa5eaf9a76bb402fcbde5da95cfe012724a7f76 Mon Sep 17 00:00:00 2001 From: CMK Date: Wed, 30 Mar 2022 17:34:47 +0800 Subject: [PATCH] chore: add how it work guide --- Documentation/How-it-works.md | 14 ++++++++++++++ Documentation/Setup.md | 4 ++-- 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 Documentation/How-it-works.md diff --git a/Documentation/How-it-works.md b/Documentation/How-it-works.md new file mode 100644 index 000000000..6d1462b45 --- /dev/null +++ b/Documentation/How-it-works.md @@ -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 + diff --git a/Documentation/Setup.md b/Documentation/Setup.md index ede9d4862..26f7f699f 100644 --- a/Documentation/Setup.md +++ b/Documentation/Setup.md @@ -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. \ No newline at end of file +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. \ No newline at end of file