Skip to content

Commit

Permalink
[+] add README.md and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
heng30 committed Mar 30, 2024
1 parent 424b271 commit d2bbeda
Show file tree
Hide file tree
Showing 8 changed files with 38 additions and 28 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ keystore_password = "123456"

[package.metadata.android.sdk]
min_sdk_version = 23
max_sdk_version = 29
target_sdk_version = 30
max_sdk_version = 34
target_sdk_version = 32

[[package.metadata.android.uses_permission]]
name = "android.permission.WRITE_EXTERNAL_STORAGE"
Expand Down
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
![screenshot](./screenshot/bitbox-en.png)
<div style="display: flex, margin: 8px">
<img src="./screenshot/rssbox-en.png" width="100"/>
<img src="./screenshot/rssbox2-en.png" width="100"/>
</div>

[中文文档](./README.zh-CN.md)

#### Introduction
It is a remote bitcoin wallet. Using blockstream API to broadcast transaction and fetch on chain information. I test it only in bitcoin **test network**, so you take you only risk to use this bitcoin light wallet on the bitcoin man network.
It is a RSS client. It is designed for android platform. However, you can compile it for Linux/Windows, maybe Macos(I'm not verify it), platform. It is a pure Rust project. UI based on `Slint UI`. Feel free to use it. If you encounter any problem, sending me a feedback.

#### Features
- [x] new wallet account
- [x] recover wallet account
- [x] send and receive bitcoin
- [x] show transations activity
- [x] address book
- [x] Show RSS new message.
- [x] Collect the message you like.
- [x] Add, edit and delete a RSS.
- [x] Add RSS from the [Find] page. Maybe support online search latterly.
- [x] Setting for UI, reading, sync, proxy, clear cache and others.

##### Android platform build information
- `min-sdk-version = 23`
- `max-sdk-version = 34`
- `target-sdk-version = 32`

#### How to build?
- Install `Rust` and `Cargo`
- Run `make`
- Install Android `sdk`, `ndk`, `jdk17`, and set environment variables
- Run `make` to build a release version android APK
- Run `make debug` to run it on desktop platform
- Refer to [Makefile](./Makefile) for more information

#### Reference
Expand All @@ -24,3 +34,4 @@ It is a remote bitcoin wallet. Using blockstream API to broadcast transaction an
- [LSP (Language Server Protocol) Server for Slint](https://github.com/slint-ui/slint/tree/master/tools/lsp)
- [top-rss-list](https://github.com/weekend-project-space/top-rss-list)
- [rss-list](https://github.com/saveweb/rss-list)
- [developer.android.com](https://developer.android.com/guide)
33 changes: 16 additions & 17 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
![screenshot](./screenshot/bitbox-cn.png)
<div style="display: flex, margin: 8px">
<img src="./screenshot/rssbox-cn.png" width="100"/>
<img src="./screenshot/rssbox2-cn.png" width="100"/>
</div>

[English Documentation](./README.md)

#### 简介
一个remote bitcoin 钱包。使用 blockstream API 进行广播交易和获取链上信息。目前只在**测试网**进行了发送和接收BTC测试。如果你在主网使用该钱包,后果自负
这是一个RSS客户端。专门为安卓端写的,当然你也可以编译Linux, Windows (也许Macos)平台的程序。这是一个纯Rust项目,界面基于`Slint UI`。 遇到任何问题都可以给我反馈

#### 功能
- [x] 生成钱包账号
Expand All @@ -12,28 +15,24 @@
- [x] 展示交易活动
- [x] 地址簿

##### 安卓平台编译信息
- `min-sdk-version = 23`
- `max-sdk-version = 34`
- `target-sdk-version = 32`

#### 如何构建?
- 安装 `Rust``Cargo`
- 运行 `make`
- 安装 Android `sdk`, `ndk`, `jdk17`, 和设置对应的环境变量
- 运行 `make` 编译安卓平台程序
- 运行 `make debug` 编译桌面平台程序
- 参考 [Makefile](./Makefile) 了解更多信息

#### 测试网水龙头
- https://testnet.qc.to/
- https://testnet-faucet.mempool.co/
- https://coinfaucet.eu/en/btc-testnet/
- https://bitcoinfaucet.uo1.net/
- https://onchain.io/bitcoin-testnet-faucet
- https://testnet.help/en/btcfaucet/testnet
- https://tbtc.mocacinno.com/

#### 参考
- [Slint Language Documentation](https://slint-ui.com/releases/1.0.0/docs/slint/)
- [github/slint-ui](https://github.com/slint-ui/slint)
- [Viewer for Slint](https://github.com/slint-ui/slint/tree/master/tools/viewer)
- [LSP (Language Server Protocol) Server for Slint](https://github.com/slint-ui/slint/tree/master/tools/lsp)
- [rust-bitcoin](https://github.com/rust-bitcoin/rust-bitcoin/)
- [decode-transaction](https://www.blockchain.com/explorer/assets/btc/decode-transaction)
- [btc testnet faucet](https://coinfaucet.eu/en/btc-testnet/)
- [bip39](https://iancoleman.io/bip39/)
- [walletsrecovery.org](https://walletsrecovery.org/)
- [top-rss-list](https://github.com/weekend-project-space/top-rss-list)
- [rss-list](https://github.com/saveweb/rss-list)
- [developer.android.com](https://developer.android.com/guide)

Binary file added screenshot/rssbox-cn.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/rssbox-en.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/rssbox2-cn.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/rssbox2-en.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/version.rs
Original file line number Diff line number Diff line change
@@ -1 +1 @@
pub static VERSION: &str = "v0.3.0";
pub static VERSION: &str = "v0.4.0";

0 comments on commit d2bbeda

Please sign in to comment.