From 9b0d3118263c96a7a56f6c00bc50169e24b8071d Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Fri, 9 May 2014 20:48:05 -0500 Subject: [PATCH] Update README.md. --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5544131d..db7f1644 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,22 @@ This package is currently under development. You really probably don't want to use this yet! -## Examples +## Documentation -The following client examples are available in the [examples](https://github.com/conformal/btcrpcclient/blob/master/examples) -directory: - -- [bitcoincorehttp](https://github.com/conformal/btcrpcclient/blob/master/examples/bitcoincorehttp) - Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled - and gets the current block count -- [btcdwebsockets](https://github.com/conformal/btcrpcclient/blob/master/examples/btcdwebsockets) +* [API Reference](http://godoc.org/github.com/conformal/btcrpcclient) +* [btcd Websockets Example](https://github.com/conformal/btcrpcclient/blob/master/examples/btcdwebsockets) Connects to a btcd RPC server using TLS-secured websockets, registers for block connected and block disconnected notifications, and gets the current block count +* [Bitcoin Core HTTP POST Example](https://github.com/conformal/btcrpcclient/blob/master/examples/bitcoincorehttp) + Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled + and gets the current block count + +## Installation + +```bash +$ go get github.com/conformal/btcrpcclient +``` ## License