commit 1bfb6cef659c9d3d86373df7e5d6f4e9da4581ac
Author: David Voznyarskiy <davidv@no-reply@disroot.org>
Date: Fri Mar 20 23:13:38 2026 -0700
added readme.md
Signed-off-by: David Voznyarskiy <davidv@no-reply@disroot.org>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ecf4474
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+## Shroomgit
+A program to quickly generate a static page of your git repos.
+Inspired by [stagit](https://codemadness.org/stagit.html)
+
+## Build
+```sh
+git clone https://git.disroot.org/davidv/shroomgit.git
+cd shroomgit
+make
+```
+The binaries will be within the `bin/` directory
+
+## Usage
+### shindex
+```
+shindex repo1 repo2 > index.html
+```
+### shgit
+not yet created
