From b6d3f5d21e8a020debebe8c5424e8f16eb9d9d33 Mon Sep 17 00:00:00 2001 From: Roy Lee Date: Tue, 4 Jan 2022 09:59:47 -0800 Subject: [PATCH] [lbry] rpc: update README.md for examples --- rpcclient/examples/lbcdblocknotify/README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/rpcclient/examples/lbcdblocknotify/README.md b/rpcclient/examples/lbcdblocknotify/README.md index dd284f2c..12d8a80a 100644 --- a/rpcclient/examples/lbcdblocknotify/README.md +++ b/rpcclient/examples/lbcdblocknotify/README.md @@ -1,5 +1,4 @@ -lbcd Websockets Example -======================= +# lbcd Websockets Example This example shows how to use the rpcclient package to connect to a btcd RPC server using TLS-secured websockets, register for block connected and block @@ -7,25 +6,27 @@ disconnected notifications, and get the current block count. ## Running the Example -The first step is to use `go get` to download and install the rpcclient package: +The first step is to clone the lbcd package: ```bash -$ go get github.com/lbryio/lbcd/rpcclient +$ git clone github.com/lbryio/lbcd ``` -Next, modify the `main.go` source to specify the correct RPC username and -password for the RPC server: +Next, navigate to the example's directory and modify the `main.go` source to +specify the correct RPC username and password for the RPC server: + +```bash +$ cd rpcclient/examples/lbcdblocknotify +``` ```Go User: "yourrpcuser", Pass: "yourrpcpass", ``` -Finally, navigate to the example's directory and run it with: +Finally, run it with: ```bash -$ git clone github.com/lbryio/lbcd -$ cd rpcclient/examples/lbcdblocknotify $ go run . ```