]> Untitled Git - bdk-cli/commitdiff
Add more examples to the README.md
authorSteve Myers <steve@notmandatory.org>
Fri, 18 Dec 2020 16:28:21 +0000 (08:28 -0800)
committerSteve Myers <steve@notmandatory.org>
Tue, 22 Dec 2020 18:27:03 +0000 (10:27 -0800)
README.md

index 73fc745e1a7dfc85d6fef09e600eab9ca58f7345..a78d6afab85cd4444f193feb1b258b54a5d56b61 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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
 ```
\ No newline at end of file