From bb55f1c8fe66c0cbb4d4b8fc1f844430ce0c9161 Mon Sep 17 00:00:00 2001 From: Florian <45694132+flo-bit@users.noreply.github.com> Date: Wed, 18 Mar 2026 00:48:25 +0100 Subject: [PATCH] update readme --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e122a89..e73c872 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ Edit `src/config.ts` — this is the only file you need to touch: ```ts export const config: ContrailConfig = { + namespace: "com.example", // your reverse-domain namespace collections: { "community.lexicon.calendar.event": { relations: { @@ -84,13 +85,13 @@ All endpoints at `/xrpc/{nsid}.{method}`: | Endpoint | Description | |----------|-------------| -| `{nsid}.getRecords` | List/filter records | -| `{nsid}.getRecord` | Get single record by URI | -| `{nsid}.getUsers` | List users by record count | -| `{nsid}.getStats` | Collection statistics | -| `contrail.admin.sync` | Discover + backfill (requires `ADMIN_SECRET`) | -| `contrail.admin.getCursor` | Current cursor position | -| `contrail.admin.getOverview` | All collections summary | +| `{collection}.listRecords` | List/filter records | +| `{collection}.getRecord` | Get single record by URI | +| `{namespace}.getProfile` | Get a user's profile by DID or handle | +| `{namespace}.admin.sync` | Discover + backfill (requires `ADMIN_SECRET`) | +| `{namespace}.admin.getCursor` | Current cursor position | +| `{namespace}.admin.getOverview` | All collections summary | +| `{namespace}.admin.reset` | Delete all data (requires `ADMIN_SECRET`) | ### Query parameters -- 2.51.2