From: Steve Myers Date: Fri, 18 Dec 2020 16:28:21 +0000 (-0800) Subject: Add more examples to the README.md X-Git-Tag: v0.1.0~11 X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/scripts/struct.EncoderStringWriter.html?a=commitdiff_plain;h=9ce5a561232096531b9aae6afb6317cb518a9c1e;p=bdk-cli Add more examples to the README.md --- diff --git a/README.md b/README.md index 73fc745..a78d6af 100644 --- 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