From 52db6a3bf4f3586309e41f49e8429a85aacce060 Mon Sep 17 00:00:00 2001
From: dawn <90008@gaze.systems>
Date: Fri, 6 Mar 2026 14:28:46 +0300
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9cdddb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# random.wisp.place
+
+visit [random.wisp.place](https://random.wisp.place) and you'll be redirected to a random [wisp.place](https://wisp.place) site. under the hood, a [hydrant](https://tangled.org/did:plc:dfl62fgb7wtjj3fcbb72naae/hydrant) instance indexes `place.wisp.fs` and `place.wisp.domain` records from the network, keeping a database of known sites, allowing the backend to pick a random website to redirect you to.
+
+custom domains are resolved via the wisp.place domain API and kept in sync as records are created or deleted.
+
+you can inspect the deployed backend instance at `https://wisp-random.ptr.pet`.
+
+## running
+
+```sh
+deno task dev
+```
+
+environment variables:
+
+| variable | default | description |
+| :--- | :--- | :--- |
+| `PORT` | `8080` | port to listen on |
+| `WISP_API_URL` | `https://wisp.place` | wisp.place appview base URL |
+| `HYDRANT_BIN` | `hydrant` | path to the hydrant binary |
+| `KV_PATH` | `random-wisp-place.kv` | deno KV database path |
+
+## building the frontend
+
+```sh
+API_URL=https://example.org deno task build
+```
+
+outputs to `dist/`.
-- 
2.51.2