Add Install page

This commit is contained in:
Roei Erez
2023-05-07 18:49:29 +03:00
parent 77206a641d
commit 8efe8b9e42
3 changed files with 50 additions and 0 deletions

View File

@@ -2,6 +2,7 @@
# API Overview # API Overview
- [Install](guide/install.md)
- [Getting Started](guide/getting_started.md) - [Getting Started](guide/getting_started.md)
- [Lightning payments](guide/payments.md) - [Lightning payments](guide/payments.md)
- [Receiving an on-chain transaction](guide/recieve_onchain.md) - [Receiving an on-chain transaction](guide/recieve_onchain.md)

View File

@@ -11,6 +11,10 @@ The Breez SDK provides the following services:
Connecting to a node requires a seed (your master key) and credentials. The seed is a bip39 mnemonic and the credentials are retrieved by registering a new node or recovering an existing one. Connecting to a node requires a seed (your master key) and credentials. The seed is a bip39 mnemonic and the credentials are retrieved by registering a new node or recovering an existing one.
## Installation
Breez SDK is available in several platforms. Follow the [install](install.md) page to install on your platform.
## Registering a new node ## Registering a new node
```rust,no_run ```rust,no_run
let seed = <your seed>; let seed = <your seed>;

45
src/guide/install.md Normal file
View File

@@ -0,0 +1,45 @@
# Install
The Breez SDK is available in the following platforms:
## Android
We recommend integrating the Breez SDK as Gradle dependency from [our Maven repository](https://mvn.breez.technology/releases).
To do so, add the following to your Gradle dependencies:
``` groovy
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](https://github.com/breez/breez-sdk-swift).
## React Native
We recommmend using the official npm package:
```console
$ npm install @breeztech/react-native-breez-sdk
```
or
```console
$ yarn add @breeztech/react-native-breez-sdk
```
## C#
Currently c# is built from source only. Please visit the [sdk-bindings](https://github.com/breez/breez-sdk/tree/main/libs/sdk-bindings#c) 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](https://github.com/breez/breez-sdk/tree/main/libs/sdk-core) project for instructions.