diff --git a/README.md b/README.md index a311b5801b5a2b9d5cf53877047b28e862348a85..c3a896a516ebf2a7a21a1be05cd40e5619f79f73 100644 --- a/README.md +++ b/README.md @@ -8,39 +8,26 @@ - [XXClient Quick Start Guide](Docs/XXClient-quick-start-guide.md) - [XXMessengerClient](Docs/XXMessengerClient.md) -## 📱 Demo +## 📱 Examples -Checkout included example iOS application. +Check out included [examples](Examples). ## 🛠Development -Open `ElixxirDAppsSDK.xcworkspace` in Xcode (≥13.4). +Open `Package.swift` in Xcode (≥13.4). ### Project structure ``` -ElixxirDAppsSDK [Xcode Workspace] - ├─ elixxir-dapps-sdk-swift [Swift Package] - | ├─ XXClient [Library] - | └─ XXMessengerClient [Library] - └─ Example [Xcode Project] - ├─ ExampleApp (iOS) [iOS App Target] - ├─ example-app [Swift Package] - | ├─ AppFeature [Library] - | └─ ... - └─ example-app-icon [Swift Package] - ├─ ExampleAppIcon [Library] - └─ example-app-icon-export [Executable] +elixxir-dapps-sdk-swift [Swift Package] + ├─ XXClient [Library] + └─ XXMessengerClient [Library] ``` ### Build schemes - Use `exlixxir-dapps-sdk-swift` scheme to build and test the package. -- Use `ExampleApp (iOS)` to build and run the example app. -- Use `example-app` scheme to build and test the example app package with all contained libraries. -- Use `ExampleAppIcon` scheme with macOS target to build and preview the example app icon. -- Use `example-app-icon-export` scheme with macOS target to build and update the example app icon. -- Use other schemes, like `XXClient`, for building and testing individual libraries in isolation. +- Use other schemes (like `XXClient`) for building and testing individual libraries in isolation. ## 📄 License