lbcd/examples/btcdwebsockets/README.md
2015-01-15 21:21:40 -06:00

37 lines
949 B
Markdown

btcd Websockets Example
=======================
This example shows how to use the btcrpcclient package to connect to a btcd
RPC server using TLS-secured websockets, register for block connected and block
disconnected notifications, and get the current block count.
This example also sets a timer to shutdown the client after 10 seconds to
demonstrate clean shutdown.
## Running the Example
The first step is to use `go get` to download and install the btcrpcclient
package:
```bash
$ go get github.com/btcsuite/btcrpcclient
```
Next, modify the `main.go` source to specify the correct RPC username and
password for the RPC server:
```Go
User: "yourrpcuser",
Pass: "yourrpcpass",
```
Finally, navigate to the example's directory and run it with:
```bash
$ cd $GOPATH/src/github.com/btcsuite/btcrpcclient/examples/btcdwebsockets
$ go run *.go
```
## License
This example is licensed under the [copyfree](http://copyfree.org) ISC License.