Skip to content

Commit 41f2ada

Browse files
committed
docs: Update README
1 parent a82eda2 commit 41f2ada

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -134,10 +134,10 @@ your `--bitcoind-url` (defaults to `http://127.0.0.1:<default-rpc-port>`),
134134

135135
You can set multiple `--xpub`s to track. This also supports ypubs and zpubs.
136136

137-
Alternatively, you can also track output script descriptord via `--descriptor`. For example, `--descriptor 'wpkh(<xpub>/0/*)'`.
137+
You can also track output script descriptors using `--descriptor`. For example, `--descriptor 'wpkh(<xpub>/0/*)'`.
138138

139139
Rescanning can be controlled with `--xpub <xpub>@<rescan>`. You can specify `<rescan>` with the wallet birthday formatted
140-
as `yyyy-mm-dd` to scan from that date onwards only, or use `none` to disable rescanning entirely (for newly created wallets).
140+
as `yyyy-mm-dd` to scan from that date onwards only, or use `now` to disable rescanning and watch for new transactions only (for newly created wallets).
141141
*Setting this can significantly speed up scanning and is highly recommended.*
142142

143143
By default, the Electrum server will be bound on port `50001`/`60001`/`60401` (according to the network)
@@ -263,15 +263,12 @@ For example, to broadcast transactions over Tor using the blockstream.info onion
263263

264264
You can setup bwt as an Electrum plugin that embeds the Electrum server into the Electrum wallet.
265265

266-
> ⚠️ **NOTE:** The plugin supports watch-only wallets only and **cannot be used with hot wallets**.
267-
> This is done as a security measure, which is expected to eventually be relaxed.
268-
> You can use the plugin with hardware wallets or with an offline Electrum setup.
269-
> For hot wallets, you will need to setup a standalone server instead of using the plugin, ideally away from your keys.
266+
![Screenshot of bwt integrated into Electrum](doc/electrum-plugin.png)
270267

271268
Download the `electrum_plugin` package from the [releases page](https://github.com/shesek/bwt/releases), verify the signature and unpack into your `electrum/plugins` directory.
272269
After restarting Electrum, you should see bwt in the list of installed plugins under `Tools -> Plugins`.
273270

274-
The plugin supports Electrum v3 and v4. It is available for Linux, Mac, Windows and ARM.
271+
The plugin supports Electrum v3 and v4. It works with multi-signature wallets. It is available for Linux, Mac, Windows and ARM.
275272

276273
Note that it is not possible to install external plugins with the Electrum AppImage or standalone Windows executable.
277274
You will need to [run from tar.gz](https://github.com/spesmilo/electrum/#running-from-targz) on Linux, use the Windows installer, or [run from source](https://github.com/spesmilo/electrum/#development-version-git-clone).
@@ -282,7 +279,10 @@ To avoid connecting to public servers while setting up the plugin, make sure the
282279

283280
To build the plugin from source, first build the binary as [described here](#from-source), copy it into the `contrib/electrum-plugin` directory, then place that directory under `electrum/plugins`, *but renamed to `bwt`* (Electrum won't recognize it otherwise).
284281

285-
![Screenshot of bwt integrated into Electrum](doc/electrum-plugin.png)
282+
> ⚠️ **NOTE:** The plugin supports watch-only wallets only and **cannot be used with hot wallets**.
283+
> This is done as a security measure, which is expected to eventually be relaxed.
284+
> You can use the plugin with hardware wallets or with an offline Electrum setup.
285+
> For hot wallets, you will need to setup a standalone server instead of using the plugin, ideally away from your keys.
286286
287287
## Manual Electrum setup (without the plugin)
288288

@@ -292,14 +292,14 @@ To build the plugin from source, first build the binary as [described here](#fro
292292
$ electrum --skipmerklecheck --oneserver --server 127.0.0.1:50001:t
293293
```
294294

295-
Note that setting `--skipmerklecheck` is only necessary if your node is pruned,
296-
but it can also be used to save some resource when combined with `--electrum-skip-merkle`.
297-
See [more details here](#pruning).
298-
299295
Alternatively, you can also set `127.0.0.1:50001:t` as your server using the server selection GUI
300296
(note the `:t`, which disables TLS). Note, however, that it is not possible to configure `oneserver`
301297
and `skipmerklecheck` using the GUI.
302298

299+
> Note that setting `--skipmerklecheck` is only necessary if your node is pruned,
300+
but it can also be used to save some resource when combined with `--electrum-skip-merkle`.
301+
See [more details here](#pruning).
302+
303303
## HTTP API
304304

305305
All the endpoints return JSON. All bitcoin amounts are in satoshis.

0 commit comments

Comments
 (0)