Summary
Our current README.md is essentially the original spotify-tui README with spotatui-specific edits layered on top. As spotatui has grown into its own project (native streaming, synced lyrics, real-time audio visualization, and multiple non-Spotify sources), the README has become a patchwork. It's time for a community-driven rewrite that tells spotatui's own story from scratch.
This is an open, collaborative effort. You don't need to write code to help. There are two ways to contribute:
- Write docs — draft or refine any section, propose a new structure, fix outdated bits, add screenshots/GIFs, improve the getting-started flow, etc.
- Ask questions — if something about spotatui is unclear to you as a user, ask it here. A good README answers real user questions, so every question is a useful signal for what a section should cover.
Goals
- A README that reads as spotatui's own, not an edited fork of spotify-tui's.
- Clear, welcoming onboarding for the multi-source reality (Spotify is now optional).
- Easy for newcomers to skim and for contributors to extend.
Hard requirements (must be preserved in any rewrite)
These are non-negotiable and must remain in the new README:
- All-contributors sections — both the spotatui Contributors and the Upstream Contributors (spotify-tui) lists must stay in full.
- Current badges — the existing badge row (Crates.io, upstream, X/Twitter, songs-played counter, contributor counts).
- Total songs played — the "Songs played using spotatui" counter badge and the Song History chart (
chart.svg).
- Star chart — the Star History section.
Everything else is open for discussion: structure, tone, section ordering, what to trim, what to expand.
How to help
- Have an idea for the structure or a section? Comment below with a proposal, or open a draft PR against
README.md.
- Confused about something? Drop your question in the comments. It directly shapes what the README needs to explain.
- Want to claim a section? Say so in a comment so we don't duplicate effort.
Let's make a README that new users love and contributors are proud of.
Summary
Our current
README.mdis essentially the original spotify-tui README with spotatui-specific edits layered on top. As spotatui has grown into its own project (native streaming, synced lyrics, real-time audio visualization, and multiple non-Spotify sources), the README has become a patchwork. It's time for a community-driven rewrite that tells spotatui's own story from scratch.This is an open, collaborative effort. You don't need to write code to help. There are two ways to contribute:
Goals
Hard requirements (must be preserved in any rewrite)
These are non-negotiable and must remain in the new README:
chart.svg).Everything else is open for discussion: structure, tone, section ordering, what to trim, what to expand.
How to help
README.md.Let's make a README that new users love and contributors are proud of.