- This repo contains a Readwise Reader → local Markdown sync service and a small webhook helper for instant event delivery.
- Keep runtime state, logs, secrets, caches, and synced content out of the repo.
The
.gitignorecovers the common paths; add new patterns there rather than relying on ad-hoc exclusions. - Prefer environment variables for tokens and machine-specific paths. Avoid
hard-coding absolute filesystem paths in tracked files; if a default is
needed, derive it from
$HOMEor the script's own location. - Before opening a PR, run the existing test suite under
tests/and add coverage for any new behavior. - Do not commit
.env, logs, caches, virtualenvs, or synced content output directories.