1 files changed, 27 insertions, 0 deletions
diff --git a/go/README.markdown b/go/README.markdown
new file mode 100644
index 00000000..17deb7d6
--- /dev/null
+++ b/go/README.markdown
@@ -0,0 +1,27 @@
+go - minimalistic uri shortener
+
+# installation
+    npm install
+
+  optionally
+    npm install hiredis
+
+# run service
+    HOSTN=go PORT=80 node .
+
+  if you omit `HOSTN`, then relative shortened uris will be generated.
+
+# add uri
+    curl -F uri=https://mywaytoolonguri http://go
+
+  this will give you a shortened uri.
+
+# resolve uri
+
+  curl -L http://go/1
+
+# clear database
+
+    redis-cli keys 'go:*' | xargs redis-cli del
+
+  if you have changed `redisPrefix`, then use that instead of `go:`.