Skip to content

Commit 5f1135e

Browse files
add docs
1 parent 82c52c7 commit 5f1135e

File tree

5 files changed

+24
-1
lines changed

5 files changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
# floresta_app
1+
# floresta_app
2+
3+
![cover](/docs/Floresta_app_cover.png)
4+
5+
This repository contains the code for an Android Bitcoin Wallet powered by [Floresta](https://github.com/vinteumorg/floresta). It currently works
6+
only on [signet](https://en.bitcoin.it/wiki/Signet), you can try to get some coins to test [here](https://signetfaucet.com/)
7+
8+
## Architecture
9+
10+
To make this work, florestad is spawned as a foreground service, that keeps running on the background. When you need to access it, the wallet
11+
uses either the RPC or Electrum Protocol to request data. By doing so, we can have all the Bitcoin-related functionality inside a single
12+
application, without requiring additional steps from the user.
13+
14+
![Archtecture](/docs/Archtecture.png)
15+
16+
## Building
17+
18+
The easiest way to build this project is through [Android Studio](https://developer.android.com/studio). Inside it you can build and export the
19+
native APK to your devices. We currently support armv8 and x86_64. The minimum API level is 27.
20+
21+
## Screenshots
22+
23+
![screenshot1](/docs/screenshot1.webp)
24+
![screenshot1](/docs/screenshot2.webp)

docs/Archtecture.png

40.7 KB
Loading

docs/Floresta_app_cover.png

138 KB
Loading

docs/screenshot1.webp

7.63 KB
Loading

docs/screenshot2.webp

6.95 KB
Loading

0 commit comments

Comments
 (0)