Add basic documentation

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..58c48c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# gopher-proxy
+
+gopher-proxy is a tiny [wai](https://hackage.haskell.org/package/wai) application running on top of [warp](https://hackage.haskell.org/package/warp). It acts as a gopher-over-http proxy for a specific server, e. g. to http-ify a gopher space.
+
+## Usage
+
+Example usage:
+
+    gopher-proxy --host foo.org --http-port 8080 --css-path ./gopher-proxy.css
+
+In this particular example, gopher-proxy would proxy the foo.org gopher server, bind its http service on `127.0.0.1:8080` (to be proxied to by another web server like `nginx`) and use the specified css file.
+
+There are these additional flags which allow tweaking of exact behavior as well:
+
+option            | meaning
+------------------|--------------------------------------------------------------------------------------------------------
+`--port`          | The port of the gopher server, defaults to `70`
+`--css-url`       | The http path of the css file, defaults to `/gopher-proxy.css` (should be changed, if your gopher server has a file with the same name
+`--base-url`      | The path of the directory which will appear as root directory of gopher-proxy to the user, defaults to `/`. Should be changed if you configured your proxying web server to expose gopher-proxy as, say `/gopher-space/`.
+`--listen-public` | If this flag is set, gopher-proxy will accept connections on its public IP address(es).