From 33bce9d795be864370293e5291a5727938e6555a Mon Sep 17 00:00:00 2001
From: Will Freeman <hohosanta@me.com>
Date: Mon, 2 Feb 2026 10:39:34 -0700
Subject: [PATCH] add readme

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

diff --git a/api/README.md b/api/README.md
new file mode 100644
index 0000000..2a9f414
--- /dev/null
+++ b/api/README.md
@@ -0,0 +1,31 @@
+# DeFlock API
+
+A Fastify-based API service for DeFlock handling non-OSM related backend logic.
+
+## Endpoints
+- `/geocode?query=...` — Geocode a location
+- `/sponsors/github?username=...` — Get GitHub sponsors
+- `/healthcheck` — Health check
+
+## Development
+
+### Prerequisites
+- [Bun](https://bun.sh/) installed
+
+### Install dependencies
+```sh
+bun install
+```
+
+### Run locally
+```sh
+bun server.ts
+```
+
+## Deployment
+
+Deployed via GitHub Actions on push to `master`.
+
+## Environment Variables
+Create a `.env` file in this directory with:
+- `GITHUB_TOKEN` — Required for GitHub Sponsors endpoint