Installing

The Breez SDK is available in the following platforms:

Android

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>")
}

iOS

We recommend using our official Swift package: breez/breez-sdk-swift.

React Native

We recommmend using the official npm package:

$ npm install https://github.com/breez/breez-sdk-react-native/releases/download/0.1.2/breeztech-react-native-breez-sdk-0.1.2.tgz

$ yarn add https://github.com/breez/breez-sdk-react-native/releases/download/0.1.2/breeztech-react-native-breez-sdk-0.1.2.tgz

Go

We recommend using our official Go package: breez/breez-sdk-go.

$ go get github.com/breez/breez-sdk-go

C#

Currently c# is built from source only. Please visit the sdk-bindings project for instructions.

rust

Currently rust is still not accessible via cargo and is needed to be built from source. Please visit the sdk-core project for instructions.

Dart/Flutter

Currently Dart is built from source only. Please visit the sdk-flutter project for instructions. We're planning to publish this package to pub.dev, until then it needs to be specified as a local directory dependency.

dependencies:
  breez_sdk:
    path: <relative-path-to>/breez-sdk/libs/sdk-flutter

Python

Currently python is not acceable as a package and is needed to build it from soruce. Please visit sdk-core project for instructions.

2.1 KiB Raw Blame History