From 1e26f265496380b3b20e17d47795d853a707a6c0 Mon Sep 17 00:00:00 2001
From: metamuffin <metamuffin@disroot.org>
Date: Wed, 30 Oct 2024 13:50:17 +0100
Subject: [PATCH] readme

---
 readme.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..9c7205a
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,11 @@
+# Strichliste v2
+
+A _simpler_ trust based ledger.
+
+The entire application is contained within `strichliste.lua`. This script
+implements CGI. It was tested against Lua version 5.4.7. The "database" will be
+written to a file named `log` in the working directory.
+
+The repository also contains a configuration file for the
+[gnix http server](https://codeberg.org/metamuffin/gnix) (`gnix.yaml`) which is
+useful for development or proxyless deployments.