feat: README

refactor: change default port

1 files changed, 27 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..f38a8d1
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+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)
+
+data paths
+- db: data/shim.db
+- site files: data/sites/