mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 09:54:09 +01:00
Code Issues Projects Releases Wiki Activity

Move usage in README up and recommend our guide

Browse Source 
* Having usage up should make it more visible.
* Recommend people to use our guide as opposed to external guides which is kept up-to-date with the code.
This commit is contained in:
Martin Habovštiak 2021-08-23 14:44:09 +02:00 committed by GitHub
parent 1c90b75ec9
commit f97618e538
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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)
@ -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).