Add README.md for btcdwebsockets example.
This commit is contained in:
parent
9b0d311826
commit
315d85fa4e
1 changed files with 37 additions and 0 deletions
37
examples/btcdwebsockets/README.md
Normal file
37
examples/btcdwebsockets/README.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
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/conformal/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/conformal/btcrpcclient/examples/btcdwebsockets
|
||||
$ go run *.go
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This example is licensed under the [copyfree](http://copyfree.org) ISC License.
|
Loading…
Reference in a new issue