Author: alex wennerberg <firstname.lastname@example.org>
Date: Mon, 26 Oct 2020 22:00:08 -0700
1 file changed, 6 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
@@ -1,26 +1,16 @@
+# Flounder: a portal into the small web
A lightweight server to help users build simple Gemini sites over http(s)
Designed to help make the Gemini ecosystem more accessible.
-Flounder is designed to be very simple to host, and should be able to be relatively easily run by a single person.
-Once you've installed Flounder, you'll want to set the configuration variables. The `flounder.toml` file in this directory provides some example configuration.
-1. Install with `go get ...`
-2. For local testing, flounder will generate a TLS cert for you. However, for production, you'll need to generate a cert that matches \*.your-domain signed by a Certificate Authority.
-3. Set the cookie store key
+Requires go 1.15 and sqlite3 development libraries.
-To limit security concerns, we don't want to run this server as root.
-I'm working on an admin interface and some admin tools, but right now, you'll have to do a lot of administration at the command line via sqlite
-Flounder uses the HTTP templates in the specified templates folder. If you want to modify the look and feel of your site, or host new files, you can modify these files.