Update README.md.

This commit is contained in:
Dave Collins 2014-05-09 20:48:05 -05:00
parent f54e05c8fe
commit 9b0d311826

View file

@ -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