You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
README.md
Hush RPC Documentation Generator
This tool extracts and formats the help text for each of the Hush RPC calls.
Note: If you want to actually edit any of this RPC info, then change the hushd code directly. This tool only take what the code (not in this repository) gives us and produces HTML output from it.
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 thehush-cli
executable is within your path. - Edit the 4 fields in the
script\templates.html
file with the hushd version number you're generating Hush RPC calls for. - From the
script
directory simply rungo run hush.go
and the documentation will be produced for all Hush RPC calls and styled according to the template intemplate.html
.
How to update faq.hush.is
After generating new RPC HTML files, follow below to update faq.hush.is's RPC info
- Copy the generated files from this repo to the
/rpc
subdirectory of thefaq.hush.is
repo and make a PR there. - If you have trouble merging because it's way too many files & have to use the git CLI, then follow instructions in this Issue.
License
Released under the GPLv3 or later.
Copyright
The Hush Developers, 2021-2023
Karel Bilek, 2018 (MIT)