gtx


Branch: develop

Author
thewhodidthis <thewhodidthis@fastmail.com>
Date
Jan. 28 '23 13:17:44
Commit
08f0282b8f808195732c95de7905388fc00acd1f
Parent
aaefbf89b17002fdc72f40b241859f414d49d54e
Changes
diff --git a/readme.md b/readme.md
index 806ae01..40550fa 100644
--- a/readme.md
+++ b/readme.md
@@ -2,10 +2,22 @@
 
 Go based [git2html](https://github.com/Hypercubed/git2html) remake with custom templating support.
 
-## preview
+## setup
 
-Sample output:
-[thewhodidthis.com/modules/gtx/](https://thewhodidthis.com/modules/gtx/)
+Download from GitHub directly:
+
+```sh
+go install github.com/thewhodidthis/gtx
+```
+
+## usage
+
+At the very least pass it a repo to be parsing through:
+
+```sh
+# NOTE: Will save output in the current directory.
+gtx -r https://github.com/thewhodidthis/gtx.git
+```
 
 ## requirements