1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed51e3f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Comfier
+
+Development repo for the Comfier Open WebUI tool (`comfier.py`). To deploy, paste `comfier.py` into Open WebUI.
+
+## Setup
+    source .venv/bin/activate
+    pip install -e . --group dev
+
+## Workflow
+- Run against a real ComfyUI: `python harness.py --url http://host:8188` (see `--help`; `--cancel-after 2` simulates Stop).
+  Node mappings come from `fixtures/nodes.json` (mirrors `COMFYUI_WORKFLOW_NODES`), workflow from `fixtures/workflow.json`.
+- Offline tests (in-process fake ComfyUI): `pytest`
+- Type check: `pyright` (Open WebUI/FastAPI types come from `stubs/`)
+- Verify stubs against upstream: `python scripts/check_stubs.py` (needs network; checks against the tag in `required_open_webui_version`, or pass `--ref main`). Run it before bumping that version.
+- Lint/format: `ruff check . && ruff format .`
+
+`devkit/` provides the fake `open_webui.*` / `fastapi` modules used by the harness and tests.