Skip to content

Commit

Permalink
Merge remote-tracking branch 'kixunil/patch-5'
Browse files Browse the repository at this point in the history
  • Loading branch information
romanz committed Aug 23, 2021
2 parents 24a2128 + f97618e commit a971502
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ allowing the user to keep real-time track of his balances and his transaction hi
Since it runs on the user's own machine, there is no need for the wallet to communicate with external Electrum servers,
thus preserving the privacy of the user's addresses and balances.


## Usage

**Please prefer to use OUR usage guide!**

External guides such as RaspiBolt can be out-of-date and have various problems.
At least double-check that the guide you're using is actively maintained.
If you can't use our guide ask about what you don't understand or consider using automated deployments.

See [here](doc/usage.md) for installation, build and usage instructions.

## Features

* Supports Electrum protocol [v1.4](https://electrumx.readthedocs.io/en/latest/protocol.html)
Expand All @@ -25,10 +36,6 @@ thus preserving the privacy of the user's addresses and balances.
* [`txindex`](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch03.asciidoc#txindex) is not required for the Bitcoin node
* Uses a single [RocksDB](https://github.com/spacejam/rust-rocksdb) database, for better consistency and crash recovery

## Usage

See [here](doc/usage.md) for installation, build and usage instructions.

## Index database

The database schema is described [here](doc/schema.md).

0 comments on commit a971502

Please sign in to comment.