1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..add015a
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+httpserv
+--------
+
+httpserv is a small server to serve up a directory over HTTP.  It's usage is:
+
+    httpserve [-p port] [-d dir]
+
+By default it listens on port 80 and serves the current directory.  To use
+port 80 on UNIX/Linux you'll have to run as root to have access to such a low
+port number.
+
+By navigating to the root of the website it will generate a list of files in
+the directory and links to download each one.
+
+For security reasons sub directories aren't supported.  The basname of the
+passed file is used so that it must exist in the directory being served.