From 66a4c5f8db7dec1c2e569f6e5cde26a000630a4f Mon Sep 17 00:00:00 2001
From: dre <dre@nox.im>
Date: Wed, 7 Jul 2021 00:48:20 +0800
Subject: [PATCH] add readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..130a507
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# gmifs
+
+Gemini File Server, short gmifs, is intended to be minimal and serve static files only. It is used
+to accompany a hugo blog served via httpd and make it available via the [gemini
+protocol](https://gemini.circumlunar.space/docs/specification.gmi). Why built yet another gemini
+server? Because it's educational and that's the spirit of the protocol.
+
+Features
+- zero conf
+- one server/file directory per instance for simplicity
+
+This tool is used alongside the markdown to gemtext converter
+[md2gmi](https://github.com/n0x1m/md2gmi).
+
+Generate a server certificate
+
+```bash
+openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \
+     -days 3650 -nodes -subj "/CN=nox.im"
+```
+
+## Usage
+
+locally test it by serving a `./gemini` directory
+
+```
+./gmifs -root ./gemini
+```
+
+full example
+
+```
+gmifs -addr 0.0.0.0:1965 -root /var/www/htdocs/nox.im/gemini \
+    -cert /etc/ssl/nox.im.fullchain.pem \
+    -key /etc/ssl/private/nox.im.key
+```