docs(readme): tighten audience hook, dependency claim, and GitHub auth - #42
Merged
Conversation
- Add a one-line audience hook so readers self-select. - Replace "Zero dependencies" (the binary has plenty of crate deps) with an honest "single binary, no tmux, just git on PATH". - Drop a hard-coded version from the ASCII mockup so the screenshot doesn't rot on every release. - Note that brew works on Linux too (the formula already supports it). - Document GitHub auth lookup order — PR and CI badges silently stay blank without a token, which has been a source of confusion. - Soften "in active development" alongside the v1.x branding and link DESIGN.md for would-be contributors. Co-Authored-By: Claude <noreply@anthropic.com>
…hots - Move DESIGN.md and the V0.x / V1.x version planning notes into a dedicated design/ folder so the repo root only holds files a new contributor needs first (README, LICENSE, build files, agents.md). - Update the DESIGN.md link in README accordingly. Nothing else cross-references these files. - Reserve assets/ for hero images. README now points at assets/screenshot.png and the existing ASCII mockup is tucked into a collapsed <details> as a fallback. Drop a real PNG into assets/ to light up the hero — assets/README.md describes the convention. Co-Authored-By: Claude <noreply@anthropic.com>
Drops the real terminal capture into assets/screenshot.png, lighting up the README hero that was reserved in the previous commit. Co-Authored-By: Claude <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.
Summary
A handful of focused README polish items, plus a small repo reorg.
README
git worktree addpainful…") self-selects in or out.Cargo.tomlships ~17 runtime crates. Replaced with "single binary — no tmux, no system services, justgiton yourPATH", which is what the line actually meant.assets/screenshot.pngand is the README hero. The ASCII mockup is preserved inside a collapsed<details>as a fallback. The mockup also no longer pinsgrove v1.1.0, so it can't rot on every release.on_linuxblocks, but the README only mentioned macOS. Now says "Homebrew (macOS and Linux)".GITHUB_TOKEN/GH_TOKEN/gh auth tokenlookup order — same order assrc/github.rsand the in-app help overlay.design/DESIGN.mdfrom the contributions section.Repo layout
design/. MovesDESIGN.mdand theV0.x/V1.xversion planning notes out of the repo root intodesign/. The root now only holds files a new contributor needs first (README, LICENSE, build files,agents.md). OnlyREADME.mdcross-referenced any of these — link updated.assets/. New folder for hero images.assets/README.mddocuments the convention so future updates can overwritescreenshot.png(and an optionaldemo.gif) without touching the README.No code changes; nothing functional moves.
Test plan
assets/screenshot.pngshows as the hero.<details>block and confirm the ASCII mockup still aligns.src/github.rs.design/DESIGN.mdlink and verify it resolves.