From a31de180d80a0be3b14a5e55dcdefa06417f5568 Mon Sep 17 00:00:00 2001
From: Leo Vasanko <git@vasanko.com>
Date: Sun, 15 Oct 2023 01:31:06 +0000
Subject: [PATCH] Minimal installation instructions.

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index e69de29..68b51dc 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,15 @@
+# Web File Storage
+
+Development install:
+
+```sh
+python -m venv .venv        # Create virtual env
+. .venv/bin/activate
+pip install -e .            # Editable install
+sanic cista --reload --dev  # Runs on localhost:8000
+```
+
+Environment variable `STORAGE=<path>` may be used to choose which folder it serves. The default is current directory.
+
+No authentication is supported, so implement access control externally or be careful with your files.
+