Skip to content

docs: revamp README with logo, badges, and structure cleanup#371

Merged
pszymkowiak merged 3 commits intomasterfrom
docs/readme-revamp
Mar 6, 2026
Merged

docs: revamp README with logo, badges, and structure cleanup#371
pszymkowiak merged 3 commits intomasterfrom
docs/readme-revamp

Conversation

@pszymkowiak
Copy link
Collaborator

@pszymkowiak pszymkowiak commented Mar 6, 2026

Summary

  • Centered org logo + tagline at top
  • Badges: CI status, release version, MIT license, Discord, Homebrew
  • Language selector with translated READMEs (fr, zh, ja, ko, es)
  • Homebrew as primary install method
  • Fix Linux binary filename gnu -> musl (fixes Bug: Missing rtk-x86_64-unknown-linux-gnu.tar.gz since v0.22.2 #323)
  • Discord invite link added
  • Simplified from 871 to ~360 lines — verbose sections moved to dedicated docs

Changes

  • Removed duplicate installation/troubleshooting sections (linked to docs instead)
  • Removed maintainer security review section (linked to SECURITY.md)
  • Reorganized commands by category (files, git, test, build, containers, analytics)
  • Cleaner examples section
  • Added 5 translated READMEs (fr, zh, ja, ko, es)

Fixes #323

- Add centered logo (og-image) and tagline
- Add badges: CI, release version, license, Discord, Homebrew
- Add language links placeholder (fr, zh, ja, ko, es)
- Fix Linux binary filename (gnu -> musl) — fixes #323
- Put Homebrew as recommended install method
- Simplify and reorganize all sections (871 -> ~360 lines)
- Add Discord invite link
- Remove verbose troubleshooting (link to TROUBLESHOOTING.md instead)
- Remove detailed security review section (link to SECURITY.md)
Add localized README files linked from the main README language selector:
- README_fr.md (French)
- README_zh.md (Chinese)
- README_ja.md (Japanese)
- README_ko.md (Korean)
- README_es.md (Spanish)

Each translation includes: installation, quick start, commands overview,
how it works diagram, and links to documentation.
@pszymkowiak pszymkowiak merged commit a22fe7b into master Mar 6, 2026
2 of 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.

Bug: Missing rtk-x86_64-unknown-linux-gnu.tar.gz since v0.22.2

1 participant