added simple readme

2013-10-21 19:47:50 -07:00 · 2013-10-21 19:47:50 -07:00 · 1c6dc7bbd3
commit 1c6dc7bbd3
parent 4996fa50a2
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,18 @@
+Simple cli tool for serving files in a directory. A silly excuse for me to
+write something tiny in go.
+
+Installation:
+
+    go get bitbucket.org/smcquay/servedir
+
+use:
+
+    servedir  # default port
+
+    # specify port
+    servedir -port 6666
+
+    # allow serving hidden files/dirs
+    servedir -hidden
+
+    # or see -help