docs: give the README a productivity-tool face - #10
Merged
Conversation
The content was solid but the presentation read as a plain spec. Pull the tagline up into a centered hero with the value proposition and the pain it removes, add a CI status badge next to the existing ones, and give each section a light emoji marker so the page scans quickly. Promote the worktree caveat to a GitHub `[!WARNING]` alert so it stops being missable prose. All GitHub-flavored-markdown; no technical content dropped. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README's content was solid, but the presentation read as a plain spec. This tunes the styling toward the conventions of a typical productivity-tool README — without dropping any technical content.
Changes
<div align="center">.ci.ymlbadge alongside npm / license / runtime..env.localby hand…").Getting started→⚡ Quick start,Usage→📖 Commands.Limitationprose is now a GitHub> [!WARNING]block so it's no longer easy to skim past.All within GitHub-flavored markdown; every technical statement is preserved.
🤖 Generated with Claude Code