From f72f6228605bf29647618196a74315e556a3598b Mon Sep 17 00:00:00 2001
From: Julien Calixte <julienc@bam.tech>
Date: Mon, 9 Feb 2026 21:26:18 +0100
Subject: [PATCH] docs: update README to reflect Deno setup and project details

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 41 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 8f25a23..99e2733 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,51 @@
 # litenote-jetstream
 
-To install dependencies:
+Backend for [Litenote](https://litenote.space), a blogging platform on the AT Protocol. Listens to the Jetstream firehose for `space.litenote.note` records and serves them via a REST API.
+
+## Prerequisites
+
+- [Deno](https://deno.land/)
+
+## Setup
 
 ```bash
-bun install
+# Initialize the SQLite database
+deno task migrate
 ```
 
-To run:
+## Development
 
 ```bash
-bun run index.ts
+# Run the Jetstream listener (with watch)
+deno task jetstream
+
+# Run the API server (with watch)
+deno task server
 ```
 
-This project was created using `bun init` in bun v1.3.8. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## Production
+
+```bash
+# Run both processes
+deno task jetstream:prod & deno task server:prod
+```
+
+### Docker
+
+```bash
+docker build -t litenote-jetstream .
+docker run -p 8080:8080 -v litenote-data:/data litenote-jetstream
+```
+
+## API
+
+| Endpoint | Description |
+|---|---|
+| `GET /notes?cursor=&limit=` | Paginated notes from all users |
+| `GET /:did/notes?cursor=&limit=` | Paginated notes for a specific DID |
+
+## Environment Variables
+
+| Variable | Default | Description |
+|---|---|---|
+| `SQLITE_PATH` | `notes.db` | Path to the SQLite database file |