mirror of
https://github.com/warmbly/warmbly.git
synced 2026-08-19 00:01:14 +00:00
Matthew Meszaros
53c5371bf6
README is now a landing-page-style entry point: centered hero banner,
badges, tagline, feature grid, architecture diagram, self-hosting
table, stack rationale, quick start, project layout, testing summary,
docs index. Image placeholders reference docs/assets/{banner,
dashboard-preview,admin-preview}.png with sizing guidance in
docs/assets/README.md.
docs/INTERNAL_API_AUTH.md walks through the bearer-token model the
worker uses to call /api/v1/internal/* endpoints: where the token
lives on both sides, the constant-time compare, fail-closed semantics
when INTERNAL_API_TOKEN is unset, and the planned per-worker JWT
upgrade path.
docs/VENDOR_LOCKIN.md is the honest scorecard: each external
dependency (AWS KMS, DynamoDB, S3, Cloud Tasks, Stripe, Turnstile,
Sentry) gets a row covering self-host status, alternatives, and what
'free of this dependency' actually looks like. Includes the minimum-
viable self-host env-var set.
Image assets for the project README
Drop the following files here to populate the SaaS-style README at the repo root. Until they exist, the README will show broken image placeholders — that is expected and will resolve as soon as the files appear.
| File | Where it shows up | Suggested size |
|---|---|---|
banner.png |
Hero banner at the very top of the README | 1280 × 320 px |
dashboard-preview.png |
Marquee screenshot of the user dashboard (under the tagline) | 1600 × 900 px |
admin-preview.png |
Screenshot of the admin app in the "Admin UI" section | 1600 × 900 px |
Keep them PNG or WebP, under ~400KB each so the README loads quickly on GitHub.
For the hero banner the safest bet is centered Warmbly wordmark + tagline on a solid or subtle-gradient background. For the previews, real screenshots of the running app (with realistic but anonymized data) beat any mockup.