upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorbitflash <admin@bitflash.network>2026-08-19 15:04:03 -0300
committerbitflash <admin@bitflash.network>2026-08-19 15:04:03 -0300
commited18ab2eb0ee657f8ce1c57da41452288b0c6ef5 (patch)
tree0f2b25b65a9d0824456d87cfb51a939fce889c8a /README.md
parent6aa3dade77632f13189d2a3ef29897f29a5f9572 (diff)
readme: add Tor badge, fix Download link, note the SQLite wallet default
- add a Tor badge to the header row - point Download and the quick-start link at releases.bitflash.network; the relative ../../releases/latest 404s outside GitHub - windows quick start: the published package bundles Tor and starts a managed Tor automatically, with -nomanagedtor to turn it off - note the single-file SQLite wallet default (1.2.20) and link docs/storage.md - bump the checksum-mirror example to v1.2.20
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1782bc3..907578e 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,10 @@ CPU-only cryptocurrency. A revival of Bitcoin 0.1.0 with RandomX proof of work a
8 8
9![PoW](https://img.shields.io/badge/PoW-RandomX%20(CPU)-2ea44f?style=for-the-badge) 9![PoW](https://img.shields.io/badge/PoW-RandomX%20(CPU)-2ea44f?style=for-the-badge)
10![Privacy](https://img.shields.io/badge/addresses-.btf%20anonymous-2ea44f?style=for-the-badge) 10![Privacy](https://img.shields.io/badge/addresses-.btf%20anonymous-2ea44f?style=for-the-badge)
11![Tor](https://img.shields.io/badge/tor-onion%20service-7d4698?style=for-the-badge)
11![Fair Launch](https://img.shields.io/badge/premine-none-2ea44f?style=for-the-badge) 12![Fair Launch](https://img.shields.io/badge/premine-none-2ea44f?style=for-the-badge)
12 13
13**[Download](../../releases/latest)** 14**[Download](https://releases.bitflash.network/)**
14 15
15</div> 16</div>
16 17
@@ -46,14 +47,14 @@ For a plain SOCKS5 proxy without Tor-specific defaults, use
46 47
47## Quick start 48## Quick start
48 49
49Download the [latest release](../../releases/latest) and run. No install, no 50Download the [latest release](https://releases.bitflash.network/) and run. No
50configuration — it connects automatically and starts syncing. 51install, no configuration — it connects automatically and starts syncing.
51 52
52**Linux:** make the `.AppImage` executable and run it. 53**Linux:** make the `.AppImage` executable and run it.
53 54
54**Windows:** extract the `-windows.zip` and run `Bitflash.exe`. 55**Windows:** extract the `-windows-with-tor.zip` and run `Bitflash.exe`. Tor is
55If you want managed Tor without a separate Tor install, use the 56bundled and a managed Tor instance starts automatically, so onion transport
56`-windows-with-tor.zip` package and start Bitflash with `-managedtor`. 57works with no separate install. Pass `-nomanagedtor` to turn it off.
57 58
58Every release ships a `SHA256SUMS` covering the assets. Verifying takes a second 59Every release ships a `SHA256SUMS` covering the assets. Verifying takes a second
59and is worth doing: 60and is worth doing:
@@ -83,7 +84,7 @@ Public mirrors should make the latest checksum files available both under the
83versioned release directory and at the release root: 84versioned release directory and at the release root:
84 85
85```text 86```text
86https://releases.bitflash.network/v1.2.19/SHA256SUMS 87https://releases.bitflash.network/v1.2.20/SHA256SUMS
87https://releases.bitflash.network/SHA256SUMS # alias to latest 88https://releases.bitflash.network/SHA256SUMS # alias to latest
88``` 89```
89 90
@@ -166,6 +167,12 @@ words also cover the address the window shows you. **Both still matter** — the
166phrase and the file back up different things, and the difference is where people 167phrase and the file back up different things, and the difference is where people
167lose money. 168lose money.
168 169
170Since 1.2.20 the file is a single self-contained `wallet.sqlite` by default. A
171fresh data directory starts on it; an existing Berkeley DB `wallet.dat` keeps
172working and the desktop app converts it in one click on first run, never
173touching the original, which stays as a fallback. See
174[wallet storage](docs/storage.md).
175
169The derivation is written down in [docs/derivation.md](docs/derivation.md), with 176The derivation is written down in [docs/derivation.md](docs/derivation.md), with
170test vectors and a script that reproduces them from scratch. It is there so the 177test vectors and a script that reproduces them from scratch. It is there so the
171twelve words keep working even if this software does not: paths, address format 178twelve words keep working even if this software does not: paths, address format