Repository navigation
docs: rewrite README to lead with event-log thesis + auto-sync version banner - #14
Merged
Merged
Conversation
Reframes the README around what makes rat genuinely different from tmux/screen/zellij rather than cataloguing features. The lede is now "session state on disk, not in the daemon" with a concrete list of capabilities that cascade from it — grep across dead sessions, resurrect, read-only watch, bit-exact offline replay — and a comparison table that's honest about what rat doesn't do (panes, status bar, scripting) and what it does that the others can't. Surface-level additions: - Shields badges for release / license / platforms at the top. - Install section leads with the curl|sh one-liner (prebuilt binaries). - Every subcommand shipped as of 0.4.1 has a section (watch, grep, resurrect, replay, killall, completions) with a real use case. - Keybindings table reflects the full chord vocabulary (d/c/s/D/[/?/ literal-prefix) plus the copy-mode sub-table. - Meta-prefix caveat spells out the iTerm/Terminal.app settings. - Roadmap lifted Windows support to #1 and explains the concrete blocker (named pipes, non-setsid detach) rather than punting. Version-in-banner is now wrapped in release-please markers so the ASCII art stays in sync with the shipped release automatically. The config updater (`extra-files: ["README.md"]`) covers future bumps.
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
Two things bundled because they touch the same file:
1. README rewrite (docs)
Reframes around the event-log differentiator instead of cataloguing features. Lede is "session state on disk, not in the daemon" with a comparison table that's honest about what rat doesn't do (panes / status bar / scripting) and what it does that tmux/screen literally can't (`grep` across dead sessions, `resurrect`, bit-exact offline replay, read-only `watch`).
Shields badges at the top. Install section leads with the one-liner. Every subcommand shipped as of 0.4.1 has a section. Keybindings table reflects the full chord vocabulary (d/c/s/D/[/?/literal) plus the copy-mode sub-table.
Honest about platform: macOS + Linux native, Windows on the roadmap — not pretending to be cross-platform today.
2. Auto-sync version banner
ASCII banner's version (`v0.4.1` now) is wrapped in release-please markers. Added `extra-files: ["README.md"]` to `release-please-config.json`. Next release PR will bump both `Cargo.toml` and the banner in one motion.
Stats
Test plan