Skip to content

Improve README for app discovery - #41

Merged
olujicz merged 1 commit into
mainfrom
docs/improve-readme-conversion
Jul 23, 2026
Merged

Improve README for app discovery#41
olujicz merged 1 commit into
mainfrom
docs/improve-readme-conversion

Conversation

@olujicz

@olujicz olujicz commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Summary

  • sharpen the opening description around external-monitor control, DDC/CI, and software fallback
  • replace the developer-focused badge with release, CI, and Homebrew trust signals
  • add an early Homebrew command and a concise “Why Dimmerly?” section
  • reduce repeated distribution details while retaining the capability comparison
  • add direct changelog, bug-report, and monitor-compatibility links

Why

The README already documented Dimmerly thoroughly, but its first screen could communicate the primary value and installation path more quickly. Distribution differences were also repeated in several sections. This update improves discovery and download conversion while keeping the technical guidance available.

Validation

  • just test
  • .github/scripts/test-ci-scope.sh
  • git diff --check
  • rendered the README with GitHub’s Markdown API and verified the new sections and links
  • confirmed all external badge, release, workflow, and issue-form URLs return HTTP 200
  • confirmed the CI scope classifier returns full_ci=false for this README-only change

@olujicz
olujicz marked this pull request as ready for review July 23, 2026 15:09
@olujicz
olujicz merged commit 1eb20bb into main Jul 23, 2026
14 checks passed
@olujicz
olujicz deleted the docs/improve-readme-conversion branch July 23, 2026 15:11
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