Skip to content
Snippets Groups Projects
Commit c00ee2b0 authored by Dariusz Rybicki's avatar Dariusz Rybicki
Browse files

Update README.md

parent f8794e26
No related branches found
No related tags found
2 merge requests!102Release 1.0.0,!37Update examples
This commit is part of merge request !37. Comments created here will be created in the context of that merge request.
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment