From b211b7edb1e3aca0f30a7c4185e76583f8f95173 Mon Sep 17 00:00:00 2001
From: Steve <stryan@protonmail.com>
Date: Wed, 12 Feb 2020 20:29:32 -0500
Subject: [PATCH] add readme

---
 README | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..2f16d8e
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+SecretShop: a small Gemini server.
+
+# Features
+- Multi-site hosting (WIP)
+- CGI (WIP)
+- Fully compliant with Jetforce diagnostics
+- Probably won't kill your computer
+
+# Configuration
+SecretShop looks in it's current running directory and /etc/secretshop for it's config file.
+Configuration is in config/yaml in one of the above directories. See the sample config for more details
+but a standard file looks like such:
+
+---
+active_capsules:
+        - localhost
+localhost:
+        Hostname: "localhost"
+        Port: "1965"
+        RootDir: "/var/gemini"
+        CGIDir: "/var/gemini/cgi"
+        KeyFile: "localhost.key"
+        CertFile: "localhost.crt"
+
+
+
+# Running
+Either run the executable directly or use the SystemD unit file