Skip to content

Commit 4efb137

Browse files
committed
docs: Add CHANGELOG, update README
1 parent 4ce27ca commit 4efb137

2 files changed

Lines changed: 12 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Unreleased
2+
3+
Migrated from [`bwt-dev/bwt`](https://github.com/bwt-dev/bwt) into a standalone repo
4+
5+
(See https://github.com/shesek/bwt/commit/96ca92bbcd14df0c1badee8c997e8a458aa52aab)

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99
C FFI for [Bitcoin Wallet Tracker](https://github.com/bwt-dev/bwt), a lightweight personal indexer for bitcoin wallets.
1010

11-
Allows to programmatically manage bwt's Electrum RPC and HTTP API servers.
12-
11+
`libbwt` allows to programmatically manage bwt's Electrum RPC and HTTP API servers.
1312
It can be used as a compatibility layer for easily upgrading Electrum-backed wallets to support a
1413
Bitcoin Core full node backend (by running the Electrum server *in* the wallet),
1514
or for shipping software that integrates bwt's [HTTP API](https://github.com/bwt-dev/bwt#http-api)
@@ -75,7 +74,7 @@ The function accepts two callbacks: `init_cb` and `notify_cb`.
7574
right before bwt is started up, after the configuration is validated.
7675
7776
The `notify_cb(msg_type, progress, detail_n, detail_s)` callback will be called with error messages,
78-
progress updates and information about the running services, with the `progress` argument indicating the
77+
information about the running services and progress updates, with the `progress` argument indicating the
7978
current progress as a float from 0 to 1.
8079
The meaning of the `detail_{n,s}` field varies for the different `msg_type`s, which are:
8180
@@ -110,9 +109,10 @@ Pre-built [signed](#verifying-the-signature) & [deterministic](#reproducible-bui
110109
files are available for download from the [releases page](https://github.com/bwt-dev/libbwt/releases)
111110
for Linux, Mac, Windows and ARMv7/8.
112111
113-
> ⚠️ The pre-built library files are meant to enable quick experimentation. If you're integrating bwt
112+
> ⚠️ The pre-built libraries are meant to make it easier to get started. If you're integrating bwt
114113
> into real-world software, [building from source](#building-from-source) is *highly* recommended.
115114
115+
116116
#### Electrum-only variant
117117
118118
The pre-built libraries are also available for download as an `electrum_only` variant,
@@ -150,9 +150,6 @@ All options are optional, except for `descriptors`/`xpubs`/`addresses` (of which
150150

151151
To start the API servers, set `electrum_addr`/`http_addr`.
152152

153-
If bitcoind is running locally on the default port, at the default datadir location and with cookie auth enabled (the default),
154-
connecting to it should Just Work™, no configuration needed!
155-
156153
#### Network and Bitcoin Core RPC
157154
- `network` - one of `bitcoin`, `testnet` or `regtest` (defaults to `bitcoin`)
158155
- `bitcoind_url` - bitcoind url (defaults to `http://localhost:<network-rpc-port>/`)
@@ -161,6 +158,9 @@ connecting to it should Just Work™, no configuration needed!
161158
- `bitcoind_cookie` - path to cookie file (defaults to `.cookie` in the datadir)
162159
- `bitcoind_wallet` - bitcoind wallet to use (for use with multi-wallet)
163160

161+
> If bitcoind is running locally on the default port, at the default datadir location and with cookie auth enabled (the default),
162+
> connecting to it should Just Work™, no configuration needed.
163+
164164
#### Address tracking
165165
- `descriptors` - an array of descriptors to track
166166
- `xpubs` - an array of xpubs to track (SLIP32 ypubs/zpubs are supported too)

0 commit comments

Comments
 (0)