Conversation
- Add clear one-line value prop at top - Add npm/license badges - Lead with problem/solution comparison table - Add compact 13-host support table with generated files - Move quick start higher - Add plain-language fail-closed gates explanation - Add TODO placeholder for terminal demo (no vhs/asciinema available) - Keep existing deep documentation but reorganize for better flow - Add gentle star request at end of top section - Mirror structure in Chinese README for consistency This makes the value prop immediately clear to developers landing from Hacker News, Reddit, awesome lists, or HelloGitHub. Co-authored-by: Cyning12 <Cyning12@users.noreply.github.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
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
Rewrote the top section of README.md (and README.zh-CN.md) to make SpecWave's value proposition immediately clear to developers landing from external discovery sources (Hacker News, Reddit, awesome lists, HelloGitHub).
What Changed
Top Section (First Screen)
Structure
Verification
All claims verified against actual code:
assets/ide/host-adapt/examples/mvp-hosts.yamlTODO (Left for Future)
npx spec-wave host apply --tools cursor,claude --yes→ native files generated →verifygate check flow.Rationale
The current README opens with internal concepts ("adapt table", "P0 gates", "Harness", "ICVO") that newcomers don't understand. This causes:
The new structure:
Testing
Related