From 7adf770f0d1a928a51f93ec74c016a00cae84a60 Mon Sep 17 00:00:00 2001 From: Gareth Davies Date: Thu, 18 Oct 2018 14:02:16 -0700 Subject: [PATCH] Adding Zcash specific information --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c427ea4..4a58579 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ -# bitcoin-rpc.github.io +# Zcash RPC Documentation Generator -See folder `script` for the script for generating + template +This tool extracts and formats the help text for each of the Zcash RPC calls. The output of this script is hosted at [zcash-rpc.github.io](https://zcash-rpc.github.io). + +See the `script` directory for the `zcash.go` script that generates the output and template. + +### How to use + +Ensure that you have Go installed and a working and running `zcashd` instance and that the `zcash-cli` executable is available in `/usr/bin/zcash-cli` (or update the path to your zcash-cli executable in `zcash.go`). From the `script` directory simply run `go run zcash.go` and the documentation will be produced for all Zcash RPC calls and styled according to the template in `template.html`.