Skip to content

Commit ec31b72

Browse files
committed
docs: Update README & CHANGELOG
1 parent fb4907a commit ec31b72

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
are now identified by the descriptor checksum, addresses have descriptors associated with them,
1212
and a new `bip32_origins` field is available based on the descriptor origin information.
1313

14-
- Support for Electrum multi-signature wallets
14+
- Support for Electrum multi-signature wallets (#60)
1515

1616
For a manual server setup, this requires using the `sortedmulti()` descriptor.
1717
For example, for a 2-of-3 wallet: `sortedmulti(2,xpub1...,xpub2...,xpub3...)`.
@@ -21,15 +21,15 @@
2121
- Alpha release of [`libbwt`](https://github.com/shesek/bwt/blob/master/doc/libbwt.md) (#64), a C FFI interface for managing the bwt servers,
2222
and of [`nodejs-bwt-daemon`](https://github.com/shesek/bwt/tree/master/contrib/nodejs-bwt-daemon) (#65), a nodejs package that wraps it.
2323

24-
- Support binding on ephemeral port (e.g. `--http-addr 127.0.0.1:0`) (#63)
25-
26-
- Reduce the number of dependencies (#61)
27-
2824
- Support non-wallet transactions in `blockchain.transaction.get` / `GET /tx/:txid/hex`
29-
(requires txindex and no pruning).
25+
(requires txindex and no pruning)
3026

3127
- Emit wallet rescan and blockchain sync progress updates (via mpsc, [ffi](#64) and the console)
3228

29+
- Support binding on ephemeral port (e.g. `--http-addr 127.0.0.1:0`) (#63)
30+
31+
- Reduce the number of dependencies (#61)
32+
3333
- Shutdown cleanly, via `SIGINT`/`SIGTERM` for CLI or a custom signal for library users (#62, #66)
3434

3535
- HTTP: Alias `GET /txs/since/0` as `GET /txs`
@@ -50,7 +50,7 @@ Breaking CLI changes:
5050

5151
- The CLI now accepts a single `--rescan-since` timestamp instead of a separate one for each descriptor/xpub.
5252

53-
- The separator for environment variables with multiple options is now `;` instead of `,`.
53+
- The separator for environment variables with multiple values is now `;` instead of `,`.
5454
For example: `DESCRIPTORS="wpkh(xpub../0/*);wpkh(xpub../1/*)"`
5555

5656
## 0.1.5 - 2020-10-05

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
`bwt` is a lightweight wallet descriptor/xpub tracker and query engine for Bitcoin, implemented in Rust.
1212

1313
🔸 Personal wallet indexer (EPS-like)<br>
14-
🔸 Output script descriptor based<br>
14+
🔸 Descriptor-based tracking<br>
1515
🔸 Electrum RPC server (also available as a plugin!)<br>
1616
🔸 Developer-friendly, modern HTTP REST API<br>
1717
🔸 Real-time updates with Server-Sent-Events or Web Hooks
@@ -60,7 +60,8 @@ The index is currently managed in-memory and does not get persisted (this is exp
6060

6161
## Setting up bwt
6262

63-
Get yourself a synced Bitcoin Core node (v0.19 is recommended, v0.17 is sufficient. `txindex` is not required) and install bwt using one of the methods below.
63+
Get yourself a synced Bitcoin Core node (v0.19 is recommended, v0.17 is sufficient. `txindex` is not required, pruning [is supported](#pruning))
64+
and install bwt using one of the methods below.
6465

6566
### Installation
6667

@@ -1286,8 +1287,7 @@ Are welcome!
12861287

12871288
The only guideline is to use `cargo fmt`.
12881289

1289-
You can check out [the list of enhancement issues](https://github.com/shesek/bwt/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement)
1290-
for some ideas to work on (output script descriptors <3).
1290+
You can check out [the list of enhancement issues](https://github.com/shesek/bwt/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement).
12911291

12921292
## Reproducible builds
12931293

0 commit comments

Comments
 (0)