Skip to content

docs: add Discord badge, tech/platform badges, and Need help link#25

Merged
EtienneLescot merged 3 commits into
mainfrom
docs/readme-badges
Jun 24, 2026
Merged

docs: add Discord badge, tech/platform badges, and Need help link#25
EtienneLescot merged 3 commits into
mainfrom
docs/readme-badges

Conversation

@EtienneLescot

@EtienneLescot EtienneLescot commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Adds a row of dynamic badges to the top of the README (license, latest release, CI status, Discord, stars, tech stack, supported platforms), plus a \Need help?\ callout in the body pointing at the OpenScreen Discord.

Changes

  • 4 centered rows of badges under the subtitle (status / community / stack / platforms)
  • One-line \Need help?\ link to the Discord right below the badges

Source of truth

  • Discord invite: https://discord.gg/VvT6Vtnyh
  • All other badges pull from the GitHub repo (license, releases, Actions workflows, stargazers)
  • Tech/platform badges are static (Electron / TypeScript / React / macOS / Windows / Linux)

Summary by CodeRabbit

  • Documentation
    • Updated the README with a new badge section near the top, including license, release, build status, community, stars, and platform/technology badges.
    • Added a clearer “Need help?” link for quick access to community support.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b032e07d-8e9c-4742-8d45-173b898eea23

📥 Commits

Reviewing files that changed from the base of the PR and between 0819961 and 3c7cbf2.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md gains a new centered badges row near the top, containing shields.io badge images and links for License, Latest Release, CI status, Discord, Stars, the Electron/TypeScript/React tech stack, macOS/Windows/Linux platform support, and a "Need help?" Discord link line.

Changes

README Badges

Layer / File(s) Summary
Centered shields.io badges block
README.md
Inserts 25 lines of centered HTML/Markdown with shield.io badge images and links covering license, latest release, CI status, Discord, stars, tech stack (Electron, TypeScript, React), supported platforms (macOS, Windows, Linux), and a "Need help?" Discord link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A badge here, a badge there,
Shields of glory fill the air!
License, stars, and CI too,
Discord friends in shades of blue.
Hop along — the README's bright,
Every badge a little light! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the change but misses most required template sections like issue, type, release impact, desktop impact, screenshots, and testing. Add the missing template sections: related issue, type of change, release impact, desktop impact, screenshots/video, and testing details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the README badge and Discord help-link additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-badges

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@EtienneLescot
EtienneLescot merged commit 7eb3b60 into main Jun 24, 2026
6 checks passed
@EtienneLescot
EtienneLescot deleted the docs/readme-badges branch June 24, 2026 13:24
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