From 37769d653626008189b575b226b2fc0a0faac800 Mon Sep 17 00:00:00 2001
From: Jan Wolff <janw@mailbox.org>
Date: Sun, 17 May 2020 13:03:27 +0200
Subject: [PATCH] update readme

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index b1a4000..9af8d5e 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,34 @@ Sheldon Director
 
 A [Gemini](https://gemini.circumlunar.space/) Server written in Rust.
 
+Features
+--------
+
+This can't do much right now besides hosting some static files. In fact, the
+feature set happens to be limited to what I need to host my own gemini page.
+Coincidence?
+
+More is to come however. Specifically I'd want to add CGI support. And maybe
+reverse proxy support as well, depending on how much stuff I'll be hosting over
+Gemini.
+
+Starting
+--------
+
+Right now every relevant option needs to be given through command line
+parameters. Though handling of a configuration file is a feature I'll add
+later on.
+
+An example start can look like this:
+```sh
+sudo ./sheldond -l "[::]:1965" -l "0.0.0.0:1965" -d "klockenschooster.de" -g /var/gemini/ --user gem-data --group gem-data
+```
+
+This serves the content of the folder `/var/gemini/` over both IPv4 and IPv6
+on port 1965 on the domain `klockenschooster.de`. After opening the socket and
+reading the certificates the server sets its user and group id to the
+respective values for `gem-data`.
+
 Why "Sheldon Director"?
 -----------------------