From cc0c9460176872b1146544e017c410f0a2d2252c Mon Sep 17 00:00:00 2001 From: jahway603 Date: Fri, 18 Mar 2022 11:18:29 -0400 Subject: [PATCH] updated copyright --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 347d2d8..ff376a4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # Hush RPC Documentation Generator -This tool extracts and formats the help text for each of the Hush RPC calls. The output of this script is hosted at [rpc.hush.is](https://rpc.hush.is) +This tool extracts and formats the help text for each of the Hush RPC calls. See the `script` directory for the `hush.go` script that generates the output and template. ### How to use -Ensure that you have Go installed and a working and running `hushd` instance and that the `hush-cli` executable is within your path. From the `script` directory simply run `go run hush.go` and the documentation will be produced for all Hush RPC calls and styled according to the template in `template.html`. - -Then you copy those generated files to the `/rpc` subdirectory of the `faq.hush.is` repo and send a PR there. Currently this repo is only used to store the `hush.go` binary and template HTML. Yes this is confusing, plz improve the situation if you can. +1. Ensure that you have Go installed and a working and running `hushd` instance and that the `hush-cli` executable is within your path. +1. From the `script` directory simply run `go run hush.go` and the documentation will be produced for all Hush RPC calls and styled according to the template in `template.html`. +1. Then you copy those generated files to the `/rpc` subdirectory of the `faq.hush.is` repo and send a PR there. Currently this repo is only used to store the `hush.go` binary and template HTML. Yes this is confusing, plz improve the situation if you can. ## License @@ -16,6 +16,6 @@ Released under the GPLv3 or later. ## Copyright -The Hush Developers, 2021 +The Hush Developers, 2021-2022 Karel Bilek, 2018 (MIT)