Skip to content

Commit 5d33d15

Browse files
docs: clean up readme
1 parent cc5cbbd commit 5d33d15

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
# Bitcoindevkit Android Example Wallet
1+
# Devkit Wallet
22

33
<p align="center">
4-
<img src="./images/screenshots.png" width="700">
4+
<img src="./assets/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 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.
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 produce a production-ready wallet, and the apps only work on Testnet3, Testnet4, Signet, and Regtest.
88

9-
This demo app is a departure of the Devkit Wallet approach and is built with the following goals in mind:
9+
The demo apps are 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

1313
## Variants
1414

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.
15+
The app is available in a few variants, each showcasing different features or versions of the bitcoindevkit libraries. The variants each have their own directory, and are standalone applications by themselves. After cloning the repository, developers should open the variants in their own Android Studio instance.
16+
17+
- **[Variant — Esplora](https://github.com/bitcoindevkit/devkit-wallet/tree/master/Variant%20%E2%80%94%20Esplora):** The default branch. This app receives its bitcoin data from a public Esplora instance.
18+
- **[Variant — Kyoto](https://github.com/bitcoindevkit/devkit-wallet/tree/master/Variant%20%E2%80%94%20Kyoto):** This app uses Compact Block Filters to sync its wallet.
19+
- **[Variant — 1.0](https://github.com/bitcoindevkit/devkit-wallet/tree/master/Variant%20%E2%80%94%201.0):** This app uses the `1.2.0` version of the bitcoindevkit library, showcasing the 1.0 API.
20+
- **[Variant — 0.30](https://github.com/bitcoindevkit/devkit-wallet/tree/master/Variant%20%E2%80%94%200.30):** This app uses the `0.30.0` version of the bitcoindevkit library, showcasing the pre-1.0 API.

0 commit comments

Comments
 (0)