From 50819ec8c2b2c2fbcf9bc26d4844cf076662c0fa Mon Sep 17 00:00:00 2001
From: Andrew Gundersen <adgundersen@gmail.com>
Date: Thu, 16 Jul 2026 20:15:58 +0000
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9863aa5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# crimata-dns
+
+Small internal API for provisioning DNS on `crimata.com` via Cloudflare — used to give each new Crimata customer a free subdomain, and optionally point a custom domain at their instance.
+
+## What it does
+
+- `GET /domains/check?domain=` — check domain availability
+- `POST /domains` — create a subdomain for a customer, and optionally register + point a custom domain
+- `DELETE /domains/:recordId` — remove a DNS record
+
+Built with [Fastify](https://fastify.dev/) + TypeScript, talking to the Cloudflare API.
+
+## Running it
+
+```
+cp .env.example .env   # fill in Cloudflare API token, account ID, zone ID
+npm install
+npm run dev
+```
+
+The included `Dockerfile` builds and runs the compiled version (`npm run build` then `node dist/index.js`).
-- 
2.43.0