Skip to content
Snippets Groups Projects
README.md 1.12 KiB
Newer Older
# Elixxir dApps Swift SDK
![Swift 5.7](https://img.shields.io/badge/swift-5.7-orange.svg)
Dariusz Rybicki's avatar
Dariusz Rybicki committed
![platform iOS, macOS](https://img.shields.io/badge/platform-iOS,_macOS-blue.svg)
Dariusz Rybicki's avatar
Dariusz Rybicki committed

## 📖 Documentation 

- [XXClient Quick Start Guide](Docs/XXClient-quick-start-guide.md)
- [XXMessengerClient](Docs/XXMessengerClient.md)

Dariusz Rybicki's avatar
Dariusz Rybicki committed
## 📱 Examples
Dariusz Rybicki's avatar
Dariusz Rybicki committed
Check out included [examples](Examples).
Dariusz Rybicki's avatar
Dariusz Rybicki committed
## 🛠 Development

Open `Package.swift` in Xcode (≥14).
Dariusz Rybicki's avatar
Dariusz Rybicki committed

### Project structure

```
Dariusz Rybicki's avatar
Dariusz Rybicki committed
elixxir-dapps-sdk-swift [Swift Package]
 ├─ XXClient [Library]
 └─ XXMessengerClient [Library]
Dariusz Rybicki's avatar
Dariusz Rybicki committed
```

### Build schemes

Dariusz Rybicki's avatar
Dariusz Rybicki committed
- Use `exlixxir-dapps-sdk-swift-Package` scheme to build and test the package.
Dariusz Rybicki's avatar
Dariusz Rybicki committed
- Use other schemes (like `XXClient`) for building and testing individual libraries in isolation.
Dariusz Rybicki's avatar
Dariusz Rybicki committed

Dariusz Rybicki's avatar
Dariusz Rybicki committed

### Bindings

The package uses `Bindings.xcframework` dependency, built from [go client](https://git.xx.network/elixxir/client) repository. Use `build-bindings.sh` script to update the framework. Information about currently used version is contained in [Frameworks/Bindings.txt](Frameworks/Bindings.txt) file.

Dariusz Rybicki's avatar
Dariusz Rybicki committed
## 📄 License

Copyright © 2022 xx network SEZC

[License](LICENSE)