Skip to content

docs: modernize the README#1

Merged
hmmhmmhm merged 2 commits into
mainfrom
docs/modernize-readme
Jul 19, 2026
Merged

docs: modernize the README#1
hmmhmmhm merged 2 commits into
mainfrom
docs/modernize-readme

Conversation

@hmmhmmhm

@hmmhmmhm hmmhmmhm commented Jul 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • add CI, release, Go, and MIT shields to a compact project header
  • make the one-line installation path prominent
  • show the current tab interface accurately
  • explain session selection and creation in a three-step quickstart
  • keep platform setup, alternative installs, troubleshooting, and development details collapsible

Verification

  • rendered with the GitHub Markdown API
  • inspected on the public GitHub branch page
  • checked all badge, release, installer, and project links
  • go test ./...
  • GitHub CI passed on Ubuntu, macOS, and Windows, including the tmux integration job

@hmmhmmhm
hmmhmmhm marked this pull request as ready for review July 19, 2026 12:16
@hmmhmmhm
hmmhmmhm merged commit ff20026 into main Jul 19, 2026
4 checks passed
@hmmhmmhm
hmmhmmhm deleted the docs/modernize-readme branch July 19, 2026 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant