1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..43a5c58
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# gomod-index
+
+simple and stupid go module thingy.
+
+## usage
+
+```
+$ gomod-index -l "<listen on>" -m "<mod root>" -g "<repo root>"
+...
+```
+this will listen on "liten on" and will redirect
+go get requests to "<mod root>/mod" to git repo at "<repo root>/mod".
+
+## licence
+
+ISC (see 'LICENCE').