From 4921282646ea6089917aad0973da11569b7429eb Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Fri, 9 May 2014 01:35:27 -0500 Subject: [PATCH] Add example descriptions to README.md. --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 385c2b30..5544131d 100644 --- a/README.md +++ b/README.md @@ -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