From 8adfad679499344eb6402677c6e90ad0598522bb Mon Sep 17 00:00:00 2001 From: Seth Etter Date: Mon, 15 Jun 2026 11:34:44 -0500 Subject: [PATCH] README reduction to avoid outdated sources of truth --- README.md | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4e2b3d0..6069f3c 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ On a configurable interval the loop: 2. Diffs the response against the slugs seen on the previous fetch to find new events, then notifies every configured channel about each one. 3. On the configured day-of-week and time-of-day (in `America/Chicago`), sends a digest of the upcoming week to every channel. -The only state is the OpenMeet tokens and the set of seen slugs, both held as locals in the run loop in `main.ts`. The loop runs until `SIGINT`/`SIGTERM`. - ## Configuration Available config can be seen in `.env.example`, with more details in `src/config.ts`. @@ -26,21 +24,8 @@ npm run once # single fetch, weekly-digest format, then exit npm run once event [slug] # single fetch, new-event format ``` -## Test & typecheck +## Test, lint, and typechecking ```sh -npm test # node:test; HTTP flows run against a stubbed fetch -npm run typecheck # tsc --noEmit -``` - -## Project layout - -``` -main.ts entry point: CLI dispatch, run loop, channel wiring, signals -src/config.ts env -> Config (validation, duration parsing) -src/atproto.ts ATProto auth flow (resolve PDS, create session, service-auth token) -src/openmeet.ts OpenMeet API calls; tokens passed in and returned out, no client object -src/notify.ts Slack + stdout channels, pure message formatters -src/schedule.ts weekly digest scheduling via Temporal in America/Chicago -src/http.ts fetch wrapper with status-carrying errors +npm run check ``` -- 2.51.2