From 5a4f6d5a73a6fb005147d878c6daff80a1ffad6d Mon Sep 17 00:00:00 2001
From: Amolith <amolith@secluded.site>
Date: Sat, 8 Nov 2025 09:16:36 -0700
Subject: [PATCH] docs(readme): add

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..c34c826aafa8cbae09ca2926b4300dc0fc136768
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Sift
+
+Collaborative lists with real‑time voting and ranking. Create a room, share the link, add ideas, and sort them together with upvotes, downvotes, or vetoes.
+
+[![REUSE compliant](https://img.shields.io/badge/REUSE-compliant-brightgreen)](https://reuse.software/)
+[![License: AGPL-3.0-or-later](https://img.shields.io/badge/License-AGPL--3.0--or--later-blue)](LICENSES/AGPL-3.0-or-later.txt)
+[![Assets: CC0-1.0](https://img.shields.io/badge/Assets-CC0_1.0-lightgrey)](LICENSES/CC0-1.0.txt)
+[![Made with Deno](https://img.shields.io/badge/Made%20with-Deno-black?logo=deno&logoColor=white)](https://deno.land/)
+[![SQLite](https://img.shields.io/badge/Database-SQLite-003B57?logo=sqlite&logoColor=white)](https://www.sqlite.org/)
+
+## Why Sift?
+
+- Real‑time collaboration: everyone sees changes instantly
+- Simple ranking: upvote, downvote, or veto; items auto‑sort by score
+- Veto with care: vetoed items fall to the bottom and dim
+- Bulk input: paste many lines at once; quick brainstorms welcome
+- Keyboard‑friendly: j/k navigate • 1/2/3 vote • e edit • Del delete • ? help • Ctrl/Cmd+Z undo
+- Clean UI: light/dark themes, responsive, reduced‑motion friendly
+- Easy sharing: rooms are just links; optional room titles for context
+
+## Quick start
+
+Run the server (Deno required):
+
+```bash
+deno run \
+  --allow-net=:8294 \
+  --allow-read=./static/,./lists.db,$HOME/.cache/deno/plug \
+  --allow-write=./lists.db,$HOME/.cache/deno/plug \
+  --allow-env \
+  --allow-ffi \
+  server.ts
+```
+
+Then open http://localhost:8294 in your browser.
+
+## How it works (for users)
+
+1) Create a room and share the link, or join an existing room by code
+2) Add items one‑by‑one or paste multiple lines
+3) Vote: 1 = up, 2 = down, 3 = veto; Enter also upvotes the selected item
+4) Edit or delete items inline; reset votes when starting a new round
+5) Optionally set a room title to keep context
+
+Tip: You can deep‑link into a room via `?room=CODE`.
+
+## Notes on privacy & safety
+
+- No accounts or authentication; rooms are protected only by knowing the ID
+- Treat rooms as shared spaces—don’t post sensitive information
+
+## License
+
+- Code: AGPL‑3.0‑or‑later → see [LICENSES/AGPL-3.0-or-later.txt](LICENSES/AGPL-3.0-or-later.txt)
+- Docs/assets: CC0‑1.0 → see [LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt)
+- This project follows [REUSE](https://reuse.software/) best practices
\ No newline at end of file