Skip to content

docs: README marketing — comparison table, live demo, screenshots - #58

Merged
X4Applegate merged 4 commits into
mainfrom
readme-marketing-2026-09-17
Sep 18, 2026
Merged

X4Applegate merged 4 commits into
mainfrom
readme-marketing-2026-09-17

Conversation

@X4Applegate

Copy link
Copy Markdown
Owner

Part of the "grow the project / more stars" work.

What's in this PR

  • How it compares table — positions the real differentiator (multi-tenant, per-client branded dashboards + RBAC from one deployment, plus Omada/UniFi/Square integrations) against Uptime Kuma / Gatus / Statping-ng. Includes a fair-use disclaimer.
  • Live-demo callout promoted above the fold (uptime.richardapplegate.io).
  • Screenshots section + docs/screenshots/ scaffold. The image tags are commented out so nothing renders as a broken image — just drop real PNGs/GIF in docs/screenshots/ and uncomment.

Before you merge — add screenshots (biggest star lever)

For a visual product, screenshots are the #1 factor. Please add to docs/screenshots/:

  • dashboard.png — the public status page (this becomes the hero image)
  • admin.png — the admin console
  • incident.png — an incident timeline
  • demo.gif — a ~10s capture of the live dashboard

Then uncomment the image lines in the README. Happy to help wire them once you drop the files in.

No code changes.

…hots scaffold

- Add 'How it compares' table highlighting the multi-tenant / white-label
  differentiator vs Uptime Kuma / Gatus / Statping-ng (with a fair-use note).
- Promote the live demo (uptime.richardapplegate.io) above the fold.
- Add a Screenshots section + docs/screenshots/ scaffold (commented image
  templates so nothing renders broken until real captures are dropped in).
- Add both to the table of contents.
Captured from the sanitized public demo (/dashboard/demo) — all-green, no
client data. Wired in as the README hero (links to the live demo) and the
Screenshots section.
Captured from the sanitized demo group only (a demo-scoped manager account,
verified to expose zero client data). Adds admin.png and a 4-frame demo.gif
to the README Screenshots section.
@X4Applegate
X4Applegate merged commit 7ca9ab9 into main Sep 18, 2026
6 checks passed
@X4Applegate
X4Applegate deleted the readme-marketing-2026-09-17 branch September 18, 2026 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant