Skip to content

Commit

Permalink
Add more examples to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
notmandatory committed Dec 18, 2020
1 parent daf76ca commit 7ad537e
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,23 @@
This project provides a command line interface (cli) Bitcoin wallet library and [`REPL`](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop)
wallet tool based on the [bdk](https://github.com/bitcoindevkit/bdk) library.

### How to run the REPL tool
### REPL wallet usage examples

To run the REPL tool use the below command which returns the list of available wallet options and
commands:
To get usage information for the `repl` wallet tool use the below command which
returns a list of available wallet options and commands:

```shell
cargo run
```

To sync a wallet to the default electrum server :

```shell
cargo run -- --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync
```

To get a wallet balance with customized logging:

```shell
RUST_LOG=debug,sled=info,rustls=info cargo run -- --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" get_balance
```

0 comments on commit 7ad537e

Please sign in to comment.