From bc5af20cc0897e5c3fd717664e09518862f24516 Mon Sep 17 00:00:00 2001 From: Jack Platten Date: Tue, 10 Mar 2026 18:24:27 -0700 Subject: [PATCH] Finish cleaning up readme --- README.md | 46 ++++++++++++---------------------------------- 1 file changed, 12 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 032edd1..ce84469 100644 --- a/README.md +++ b/README.md @@ -59,40 +59,18 @@ if there's a fresh post, save it to the DB, then return. ## Configuration -Configuration can be done via environment variables or - -## Local Postgres Runner - -If you want to run the app locally without a DB sidecar setup, use: - -```bash -mise run db-setup -``` - -This task: - -- Starts a Postgres container on `localhost:54329` -- Creates the `posts` table directly (ignores migrations) -- Seeds sample rows -- Uses `ROCKET_DATABASES` from `mise.toml` - -Then start the app: - -```bash -mise run dev -``` - -Quick test: - -```bash -curl http://127.0.0.1:4321/slug/hello-world -``` - -To stop/remove the local Postgres container: - -```bash -mise run db-down -``` +Configuration can be done via environment variables with the `ATC_` prefix or a `Settings.toml` file. + +The available options are as follows: + +| Variable | Description | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| DATABASE_URL / database.url | The Postgres connection string | +| APP_ADDRESS / app.address | Address to bind to | +| APP_PORT / app.port | Port to bind to | +| POLLER_HANDLE / poller.handle | Bluesky username to check the RSS feed of | +| POLLER_EMOJI / poller.emoji | The emoji to search for | +| POLLER_DOMAIN / poller.domain | Scoping to ensure that only the correct post is found. If the post does not link to this domain, it will be skipped | ## Caveats -- 2.51.2