diff --git a/README.md b/README.md index fb93436..2d06d1f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # Bash TDP Generator TDP is an acronym for "Tilde Description Protocol", as described in [TDP RFC](http://protocol.club/~datagrok/beta-wiki/tdp.html). +## How To Use +Clone the repo. Edit setenvs.sh, and set the appropriate values for your tilde server. After that is complete, do the following: + +```./gen_tdp | json_pp + +If it's valid json, json_pp should just parse it, and make you a nice json struct. If that is all good, then do this: + +```./gen_tdp > tilde.json + +And then copy that file to where it needs to be. + ## ToDo -* Make a separate config file -* Add info header \ No newline at end of file +* None yet \ No newline at end of file