chore: add how it work guide

Documentation/Acknowledgments.md

@@ -0,0 +1,34 @@
+# Acknowledgments
+
+- [AlamofireImage](https://github.com/Alamofire/AlamofireImage)
+- [AlamofireNetworkActivityIndicator](https://github.com/Alamofire/AlamofireNetworkActivityIndicator)
+- [Alamofire](https://github.com/Alamofire/Alamofire)
+- [CommonOSLog](https://github.com/mainasuk/CommonOSLog)
+- [CryptoSwift](https://github.com/krzyzanowskim/CryptoSwift)
+- [DateToolSwift](https://github.com/MatthewYork/DateTools)
+- [DiffableDataSources](https://github.com/ra1028/DiffableDataSources)
+- [DifferenceKit](https://github.com/ra1028/DifferenceKit)
+- [FLAnimatedImage](https://github.com/Flipboard/FLAnimatedImage)
+- [FLEX](https://github.com/FLEXTool/FLEX)
+- [FPSIndicator](https://github.com/MainasuK/FPSIndicator)
+- [Fuzi](https://github.com/cezheng/Fuzi)
+- [Kanna](https://github.com/tid-kijyun/Kanna)
+- [KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess.git)
+- [Kingfisher](https://github.com/onevcat/Kingfisher)
+- [MetaTextKit](https://github.com/TwidereProject/MetaTextKit)
+- [Nuke-FLAnimatedImage-Plugin](https://github.com/kean/Nuke-FLAnimatedImage-Plugin)
+- [Nuke](https://github.com/kean/Nuke)
+- [Pageboy](https://github.com/uias/Pageboy#the-basics)
+- [PanModal](https://github.com/slackhq/PanModal.git)
+- [SDWebImage](https://github.com/SDWebImage/SDWebImage)
+- [swift-collections](https://github.com/apple/swift-collections)
+- [swift-nio](https://github.com/apple/swift-nio)
+- [SwiftGen](https://github.com/SwiftGen/SwiftGen)
+- [SwiftUI-Introspect](https://github.com/siteline/SwiftUI-Introspect)
+- [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)
+- [Tabman](https://github.com/uias/Tabman)
+- [TwidereX-iOS](https://github.com/TwidereProject/TwidereX-iOS)
+- [ThirdPartyMailer](https://github.com/vtourraine/ThirdPartyMailer)
+- [TOCropViewController](https://github.com/TimOliver/TOCropViewController)
+- [TwitterProfile](https://github.com/OfTheWolf/TwitterProfile)
+- [UITextView-Placeholder](https://github.com/devxoul/UITextView-Placeholder)

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
+

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.
+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.

README.md

@@ -4,85 +4,20 @@
 
 <a href="https://apps.apple.com/us/app/mastodon-for-iphone/id1571998974?itsct=apps_box_badge&amp;itscg=30200" style="display: inline-block; overflow: hidden; border-top-left-radius: 13px; border-top-right-radius: 13px; border-bottom-right-radius: 13px; border-bottom-left-radius: 13px; width: 250px; height: 83px;"><img src="https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/en-us?size=250x83&amp;releaseDate=1627603200&h=72b0c8495c2c0af1291efef280c4c2c1" alt="Download on the App Store" style="border-top-left-radius: 13px; border-top-right-radius: 13px; border-bottom-right-radius: 13px; border-bottom-left-radius: 13px; width: 250px; height: 83px;"></a>
 
-## Requirements
+## Introduction
 
-- Xcode 12.5+
-- Swift 5.3+
-- iOS 14.0+
+This is the repository for the official iOS App for Mastodon. You can install it from the App Store now. You can build the app from source and file bug report here. 
 
-## Setup
-We need the latest version of Xcode from App Store. And use Cocoapods for dependency management.
+Read this blog post for this app to learn more. 
+> [Developing an official iOS app for Mastodon](https://blog.joinmastodon.org/2021/02/developing-an-official-ios-app-for-mastodon/)
 
-### CocoaPods
+## Getting Start
+- Read the setup guide [here](./Documentation/Setup.md)
+- About [contributing](./Documentation/CONTRIBUTING.md)
+- [Documentation folder](./Documentation/)
 
-#### For the Intel Mac
-
-```zsh
-sudo gem install cocoapods
-sudo gem install cocoapods-keys
-pod install
-```
-
-#### For the M1 Mac
-
-```zsh
-sudo gem install cocoapods
-sudo gem install cocoapods-keys
-
-# pod install may not works on M1 Mac. Fix by install ffi
-# ref: https://github.com/CocoaPods/CocoaPods/issues/10220
-sudo arch -x86_64 gem install ffi
-
-arch -x86_64 pod install
-```
-
-## Start
-
-1. Open `Mastodon.xcworkspace` 
-2. Wait the Swift Package Dependencies resolved. 
-2. Check the signing settings make sure choose a team. [More info…](https://help.apple.com/xcode/mac/current/#/dev23aab79b4)
-3. Select `Mastodon` scheme and run it.
-
-#### Contributors
-The app require 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 is compatible with [toot-relay](https://github.com/DagAgren/toot-relay) APNs. You can set your push notification endpoint via cocoapod-keys.
-
-
-## Acknowledgements
-
-- [AlamofireImage](https://github.com/Alamofire/AlamofireImage)
-- [AlamofireNetworkActivityIndicator](https://github.com/Alamofire/AlamofireNetworkActivityIndicator)
-- [Alamofire](https://github.com/Alamofire/Alamofire)
-- [CommonOSLog](https://github.com/mainasuk/CommonOSLog)
-- [CryptoSwift](https://github.com/krzyzanowskim/CryptoSwift)
-- [DateToolSwift](https://github.com/MatthewYork/DateTools)
-- [DiffableDataSources](https://github.com/ra1028/DiffableDataSources)
-- [DifferenceKit](https://github.com/ra1028/DifferenceKit)
-- [FLAnimatedImage](https://github.com/Flipboard/FLAnimatedImage)
-- [FLEX](https://github.com/FLEXTool/FLEX)
-- [FPSIndicator](https://github.com/MainasuK/FPSIndicator)
-- [Fuzi](https://github.com/cezheng/Fuzi)
-- [Kanna](https://github.com/tid-kijyun/Kanna)
-- [KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess.git)
-- [Kingfisher](https://github.com/onevcat/Kingfisher)
-- [MetaTextKit](https://github.com/TwidereProject/MetaTextKit)
-- [Nuke-FLAnimatedImage-Plugin](https://github.com/kean/Nuke-FLAnimatedImage-Plugin)
-- [Nuke](https://github.com/kean/Nuke)
-- [Pageboy](https://github.com/uias/Pageboy#the-basics)
-- [PanModal](https://github.com/slackhq/PanModal.git)
-- [SDWebImage](https://github.com/SDWebImage/SDWebImage)
-- [swift-collections](https://github.com/apple/swift-collections)
-- [swift-nio](https://github.com/apple/swift-nio)
-- [SwiftGen](https://github.com/SwiftGen/SwiftGen)
-- [SwiftUI-Introspect](https://github.com/siteline/SwiftUI-Introspect)
-- [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)
-- [Tabman](https://github.com/uias/Tabman)
-- [TwidereX-iOS](https://github.com/TwidereProject/TwidereX-iOS)
-- [ThirdPartyMailer](https://github.com/vtourraine/ThirdPartyMailer)
-- [TOCropViewController](https://github.com/TimOliver/TOCropViewController)
-- [TwitterProfile](https://github.com/OfTheWolf/TwitterProfile)
-- [UITextView-Placeholder](https://github.com/devxoul/UITextView-Placeholder)
+## Acknowledgments
+Thanks to these open-sources projects listed [here](./Documentation/Acknowledgments.md).
 
 ## License