Installing the Breez SDK
The Breez SDK is available for several platforms. Follow the instructions below on how to install on your platform:
iOS/Swift
We support integration via the Swift Package Manager and via CocoaPods. See breez/breez-sdk-swift for more information.
Swift Package Manager
Installation via Xcode
Via File > Add Packages...
, add
https://github.com/breez/breez-sdk-swift.git
as a package dependency in Xcode.
Installation via Swift Package Manifest
Add the following to the dependencies array of your Package.swift
:
.package(url: "https://github.com/breez/breez-sdk-swift.git", from: "<version>"),
CocoaPods
Add the Breez SDK to your Podfile
like so:
target '<YourApp' do
use_frameworks!
pod 'BreezSDK'
end
Android/Kotlin
We recommend integrating the Breez SDK as Gradle dependency from our Maven repository.
To do so, add the following to your Gradle dependencies:
repositories {
maven {
url("https://mvn.breez.technology/releases")
}
}
dependencies {
implementation("breez_sdk:bindings-android:<version>")
}
Please check the troubleshooting guide if you are having problems compiling your Android application.
React Native
We recommend using the official npm package:
npm install @breeztech/react-native-breez-sdk
or
yarn add @breeztech/react-native-breez-sdk
Go
We recommend using our official Go package: breez/breez-sdk-go.
go get github.com/breez/breez-sdk-go
C#
We recommend using our official C# package: Breez.Sdk.
dotnet add package Breez.Sdk
rust
We recommend to add breez sdk as a git dependency with a specific release tag. Check https://github.com/breez/breez-sdk/releases for the latest version.
[dependencies]
breez-sdk-core = { git = "https://github.com/breez/breez-sdk", tag = "0.5.0" }
Flutter/Dart
We recommend to add our official flutter package as a git dependency.
dependencies:
breez_sdk:
git:
url: https://github.com/breez/breez-sdk-flutter.git
Python
Use the latest package here.
pip install breez_sdk