Skip to content

docs(readme): refresh content + presentation glow-up#64

Merged
rxm96 merged 10 commits into
mainfrom
docs/readme-overhaul
Jun 14, 2026
Merged

docs(readme): refresh content + presentation glow-up#64
rxm96 merged 10 commits into
mainfrom
docs/readme-overhaul

Conversation

@rxm96

@rxm96 rxm96 commented Jun 14, 2026

Copy link
Copy Markdown
Owner

Macht das README aktuell und optisch ansprechender (Inhalts-Refresh + Glow-up).

Inhalt aktualisiert

Optisch aufpoliert

  • Zentrierter Header: Logo, Tagline, Badges (Build · Latest Release · Total Downloads · Platforms · License) und Download-CTA.
  • Hero-Screenshot (overview.png) direkt unter dem Header; die übrigen drei Screenshots als 3-Spalten-Tabelle.
  • Inhaltsverzeichnis ergänzt; Tech-Stack nach unten an Referenz-Position verschoben.

Verifikation

  • Alle 10 verlinkten Dateien (Logo, LICENSE, CONTRIBUTING, THIRD_PARTY_NOTICES, watch-engine/-flow, 4 Screenshots) existieren — keine toten Links.
  • Badges sind dynamisch (shields.io / Actions) → veralten nicht.

🤖 Generated with Claude Code

rxm96 and others added 10 commits June 14, 2026 03:15
Content refresh:
- Tech stack: Electron 40 -> 42 (matches package.json).
- New feature bullets: Discord / webhook notifications and engine
  transparency (status rail, claim-retry countdown, session-expired banner
  with re-login). Tightened the "Alerts" bullet to the desktop-notification
  events.
- "Releases & updates": macOS artifacts -> a macOS .dmg (matches the lean
  release assets).

Presentation glow-up:
- Centered header with logo, tagline, and badges (build, latest release,
  total downloads, platforms, license).
- Overview screenshot promoted to a hero image; the other three move to a
  three-up Screenshots table.
- Added a table of contents; moved the tech stack down to reference position.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
github/downloads/total counts every asset download across all releases.
~80% of it (2002 of 2514) is just latest.yml fetches from the auto-updater's
update checks, not installs — a misleading vanity number. Keep the four
honest badges (build, latest release, platforms, license).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The old bullet described the feature by the flaw it removes ('instead of a
silent logout') and leaned on internal jargon ('engine-status rail', the
state arrows). Reframe it around what the user gets: a live status readout,
claim-retry countdowns, and a one-click re-login when the Twitch session
expires.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rewrites every feature bullet around user benefit instead of mechanics:
'most important actionable game' -> plain wording, 'activity audit' -> 'keeps
a record', drops the 'SSRF guard'/'HTTPS-only' implementation jargon from the
webhook bullet, and frames browser login as a security benefit. Also removes
the Warmup mode bullet (feature is slated for deprecation).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@rxm96
rxm96 merged commit f33b7a8 into main Jun 14, 2026
3 checks passed
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