docs: improve README with better structure#32
Merged
Conversation
Completely restructure README to follow best practices from similar projects (bats-core, VHS, commander-cli): - Add centered header with tagline and badges (npm, CI, license, docs) - Include code example and sample output in the first 30 lines - Clarify "Why Repterm?" section emphasizing dual execution modes (Bun.spawn + PTY), not just PTY - Expand Features list with detailed descriptions - Add Interactive Testing, Parallel Execution, and Recording sections - Include Plugins section with complete kubectl example - Add Packages table with npm links - Move all external docs references to repterm.ai with quick links - Update Contributing to link directly to plugin dev guide - Remove CONTRIBUTING-PLUGINS.md (content duplicated in docs) - Remove /specs directory (archived in docs) Co-Authored-By: Claude Opus 4.6 <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
Completely restructured the README to follow proven best practices from similar open-source projects (bats-core, VHS, commander-cli, etc.):
{ interactive: true }Cleanup
CONTRIBUTING-PLUGINS.md(content now lives in docs site and was duplicating info)/specsdirectory (archived specifications, all info integrated into docs)The README is now more discoverable, shows value immediately with code and output, and better positions Repterm's unique strengths (dual modes, structured testing framework, recording, plugins).
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com