docs: rewrite README with cleaner structure and organization#9
Closed
docs: rewrite README with cleaner structure and organization#9
Conversation
Co-Authored-By: Anno Gomes <annogomes@gmail.com>
aannoo
commented
Mar 15, 2026
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
Rewrites the README from 1,171 lines down to ~273 lines with a cleaner structure and better visual hierarchy. The detailed per-command CLI reference, full config key documentation, and script templates have been replaced with concise summaries that point users to the built-in
--helpand--infocommands.Key structural changes:
Removed content (~900 lines):
--helpoutput for every CLI subcommand (send, list, events, listen, config, transcript, bundle, term, relay, run, claude, gemini, codex, opencode)Review & Testing Checklist for Human
hcom <command> --helpandhcom config <key> --infoinstead. If this content should be preserved somewhere (e.g., adocs/folder or wiki), that work is not included here.<details>sections render correctly on GitHub.Notes
Requested by: @aannoo
Link to Devin Session
Note
Low Risk
Low risk: documentation-only changes, but the removal of extensive CLI/config reference text could affect discoverability for users who relied on the README.
Overview
Rewrites
README.mdto a much shorter, more scannable structure: separate Install vs Quickstart, add concise How it works, and present Capabilities, Supported tools, and Multi-agent workflows as tables with example prompts.Removes the long per-subcommand CLI help, detailed config key explanations, and script templates in favor of directing readers to
hcom <command> --helpandhcom config <key> --info; also updates the displayed version tov0.7.4and tweaks minor wording/formatting (e.g., ASCII arrows, LICENSE link).Written by Cursor Bugbot for commit 5650556. This will update automatically on new commits. Configure here.