1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1494a32
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+shim
+----
+
+small static site host for archive uploads.
+
+what it does
+  - users upload one archive, app publishes it under a slug
+  - public routes: /s/<slug>/... and /_site/<slug>/...
+
+quick start (assumes POSIX)
+  - python3 -m venv .venv
+  - source .venv/bin/activate
+  - pip install -r requirements.txt
+  - python3 server.py
+  - open http://127.0.0.1:8585/app
+
+config
+  - SHIM_APP_NAME: ui/app name (default: shim)
+  - SHIM_BIND: bind address (default: 0.0.0.0)
+  - SHIM_PORT: port (default: 8585)
+  - SHIM_MOJICRYPT_BIN: mojicrypt path (default: ./vendor/mojicrypt)
+  - SHIM_COOKIE_SECURE: auto|true|false (default: auto)
+  - SHIM_SQLITE_TIMEOUT_SECONDS (default: 30.0)
+  - SHIM_SQLITE_BUSY_TIMEOUT_MS (default: 30000)
+  - SHIM_SQLITE_CACHE_SIZE_KIB (default: 32768)
+  - SHIM_SQLITE_MMAP_SIZE_BYTES (default: 268435456)
+  - SHIM_SQLITE_WAL_AUTOCHECKPOINT_PAGES (default: 1000)
+
+data paths
+  - db: data/shim.db
+  - site files: data/sites/