Add example descriptions to README.md.

This commit is contained in:
Dave Collins 2014-05-09 01:35:27 -05:00
parent 2f84189676
commit 4921282646

View file

@ -12,7 +12,16 @@ You really probably don't want to use this yet!
## Examples
See the [examples](https://github.com/conformal/btcrpcclient/blob/master/examples).
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)
Connects to a btcd RPC server using TLS-secured websockets,
registers for block connected and block disconnected notifications, and gets
the current block count
## License