Skip to content

Commit 8dcdea6

Browse files
docs: add variants section to readme
1 parent 247f64c commit 8dcdea6

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,15 @@
44
<img src="./images/screenshots.png" width="700">
55
</p>
66

7-
The _Devkit Wallet_ is a wallet built as a reference app for the [bitcoindevkit](https://github.com/bitcoindevkit) on Android. It is a fork of the long-standing [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet), a repository that hosts a series of apps (4) of increasing complexity aimed at showcasing the bitcoindevkit library for beginner and advanced Android developers.
7+
The _Devkit Wallet_ is a wallet built as a reference app for the [bitcoindevkit](https://github.com/bitcoindevkit) on Android. It is a fork of the long-standing [Devkit Wallet](https://github.com/thunderbiscuit/devkit-wallet), a repository showcasing the bitcoindevkit library for beginner and advanced Android developers. This repository is not intended to be a production-ready wallet, and only works on Testnet3, Testnet4, Signet, and Regtest.
88

99
This demo app is a departure of the Devkit Wallet approach and is built with the following goals in mind:
1010
1. Be a reference application for the bitcoindevkit API on Android.
1111
2. Showcase some of the more advanced features of the bitcoindevkit library.
1212

13-
## Feature list
14-
- [x] Receive
15-
- [x] Send
16-
- [x] Sync wallet using Electrum
17-
- [x] Retrieve transaction history
18-
- [x] Wallet recovery using BIP39 recovery phrases
19-
- [x] Send to multiple recipients
20-
- [x] "Send All" functionality
21-
- [x] Choose custom Electrum server
22-
- [x] Create OP_RETURN outputs
13+
## Variants
14+
15+
The app is available in a few variants, each showcasing different features of the bitcoindevkit library. The variants live on different branches and are as follows:
16+
- **[variant/esplora](https://github.com/bitcoindevkit/devkit-wallet/tree/variant/esplora):** The default branch. This app receives its bitcoin data from a public Esplora instance.
17+
- **[variant/kyoto](https://github.com/bitcoindevkit/devkit-wallet/tree/variant/kyoto):** This app uses Compact Block Filters to sync its wallet.
18+
- **[variant/0.30.0](https://github.com/bitcoindevkit/devkit-wallet/tree/variant/0.30.0):** This app uses the `0.30.0` version of the bitcoindevkit library, showcasing the pre-1.0 API.

0 commit comments

Comments
 (0)