From 315d85fa4e705c6481679d35ea641c3d9645122c Mon Sep 17 00:00:00 2001
From: Dave Collins <davec@conformal.com>
Date: Fri, 9 May 2014 21:05:01 -0500
Subject: [PATCH] Add README.md for btcdwebsockets example.

---
 examples/btcdwebsockets/README.md | 37 +++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 examples/btcdwebsockets/README.md

diff --git a/examples/btcdwebsockets/README.md b/examples/btcdwebsockets/README.md
new file mode 100644
index 00000000..1f765fa4
--- /dev/null
+++ b/examples/btcdwebsockets/README.md
@@ -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.