mirror of https://github.com/aljazceru/breez-sdk-docs.git synced 2025-12-18 06:14:21 +01:00

Files

Ademar c72ed71d4d Add buy btc using Moonpay general instructions and an Android example (#51 )

* Update android examples

* Add buy btc moonpay doc for android and more general instructions

* Update src/guide/buy_btc.md

Co-authored-by: Ruben <36157890+ubbabeck@users.noreply.github.com>

* Update src/guide/buy_btc.md

Co-authored-by: Ruben <36157890+ubbabeck@users.noreply.github.com>

---------

Co-authored-by: Ruben <36157890+ubbabeck@users.noreply.github.com>

2023-09-21 10:27:40 -03:00

2.6 KiB

Raw Blame History

Installing

The Breez SDK is available in the following platforms:

iOS

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

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

See the example for more details

React Native

We recommmend using the official npm package:

npm install @breeztech/react-native-breez-sdk

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

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 source. Please visit sdk-core project for instructions.

2.6 KiB Raw Blame History