usage and license

1 files changed, 25 insertions, 0 deletions

diff --git a/readme.md b/readme.md
index 1415d68..304a1df 100644
--- a/readme.md
+++ b/readme.md
@@ -2,3 +2,28 @@
 
 a simple stupid reverse proxy
 
+## Usage
+
+Run the binary with the a path to the configuration as the first argument. The
+configuration file is written in TOML and could look like this:
+
+```toml
+# Both the [http] and [https] sections are optional
+[http]
+bind = "127.0.0.1:8080"
+
+[https]
+bind = "127.0.0.1:8443"
+tls_cert = "ssl/cert.pem"
+tls_key = "ssl/key.pem" # only accepts pkcs8 for now
+
+# this is a lookup table from hostnames to backend address
+# in this case, requests for `testdomain.local` are forwarded to 127.0.0.1:3000
+[hosts]
+"testdomain.local" = { backend = "127.0.0.1:3000" }
+"secondomain.local" = { backend = "1.2.3.4:5678" }
+```
+
+# License
+
+AGPL-3.0-only; see [COPYING](./COPYING)