frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md with links to padawan and tatooine

Browse Source
This commit is contained in:
Steve Myers 2021-12-21 14:25:15 -08:00
parent 2a658d2ff6
commit 9bb629d0a8
No known key found for this signature in database
GPG Key ID: 8105A46B22C2D051
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -42,7 +42,17 @@ val wallet = OnlineWallet(descriptor, null, Network.TESTNET, db, client)
val newAddress = wallet.getNewAddress() val newAddress = wallet.getNewAddress()
``` ```
### How to build ### Example Projects
#### `bdk-android`
* [padawan-wallet](https://github.com/thunderbiscuit/padawan-wallet)
#### `bdk-jvm`
* [tatooine](https://github.com/thunderbiscuit/tatooine)
## How to build
1. Clone this repository and init and update it's [`bdk-ffi`] submodule. 1. Clone this repository and init and update it's [`bdk-ffi`] submodule.
```shell ```shell
@ -66,7 +76,9 @@ val newAddress = wallet.getNewAddress()
./build.sh ./build.sh
``` ```
### How to publish to your local maven repo ## How to publish
### Publish to your local maven repo
1. Set your `~/.gradle/gradle.properties` signing key values 1. Set your `~/.gradle/gradle.properties` signing key values
```properties ```properties
@ -79,7 +91,7 @@ val newAddress = wallet.getNewAddress()
./gradlew :android:publishToMavenLocal ./gradlew :android:publishToMavenLocal
``` ```
### How to publish to maven central with [Gradle Nexus Publish Plugin] (project maintainers only) ### Publish to maven central with [Gradle Nexus Publish Plugin] (project maintainers only)
1. Set your `~/.gradle/gradle.properties` signing key values and SONATYPE login 1. Set your `~/.gradle/gradle.properties` signing key values and SONATYPE login
```properties ```properties
@ -95,8 +107,6 @@ val newAddress = wallet.getNewAddress()
./gradlew :android:publishToSonatype closeAndReleaseSonatypeStagingRepository ./gradlew :android:publishToSonatype closeAndReleaseSonatypeStagingRepository
``` ```
<!-- TODO A demo android app is available at [notmandatory/bdk-sample-app](https://github.com/notmandatory/bitcoindevkit-android-sample-app/tree/upgrade-to-bdk-ffi/) -->
[Kotlin]: https://kotlinlang.org/ [Kotlin]: https://kotlinlang.org/
[Android Studio]: https://developer.android.com/studio/ [Android Studio]: https://developer.android.com/studio/
[`bdk`]: https://github.com/bitcoindevkit/bdk [`bdk`]: https://github.com/bitcoindevkit/bdk