Skip to content

docs: rewrite README with cleaner structure and organization#9

Closed
aannoo wants to merge 1 commit intomainfrom
devin/1773379730-new-readme
Closed

docs: rewrite README with cleaner structure and organization#9
aannoo wants to merge 1 commit intomainfrom
devin/1773379730-new-readme

Conversation

@aannoo
Copy link
Copy Markdown
Owner

@aannoo aannoo commented Mar 13, 2026

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 --help and --info commands.

Key structural changes:

  • Separated Install and Quickstart into distinct sections
  • Converted "What agents can do" into a labeled Capabilities table
  • Converted tool support info from prose into a Supported tools table
  • Converted workflow descriptions into a Multi-agent workflows table
  • Condensed the collapsible CLI/Config/Scripts reference sections to summaries only
  • Promoted Build from source out of a collapsible section into a top-level heading

Removed content (~900 lines):

  • Full --help output for every CLI subcommand (send, list, events, listen, config, transcript, bundle, term, relay, run, claude, gemini, codex, opencode)
  • Detailed documentation for every config key (HCOM_TAG, HCOM_HINTS, HCOM_TERMINAL presets, HCOM_AUTO_APPROVE, relay settings, etc.)
  • Shell script template, identity handling guide, and launch/cleanup patterns for custom scripts

Review & Testing Checklist for Human

  • Decide if the removed reference content is acceptable. ~900 lines of detailed CLI docs, config key descriptions, and script templates were removed entirely (not relocated). Users are directed to hcom <command> --help and hcom config <key> --info instead. If this content should be preserved somewhere (e.g., a docs/ folder or wiki), that work is not included here.
  • Verify markdown rendering — especially the tables (Capabilities, Supported tools, Workflows) and collapsible <details> sections render correctly on GitHub.
  • Check that existing links still work — demo GIF URL, install.sh raw URL, LICENSE link, PyPI badge.

Notes

  • Minor style changes: em dashes (—) replaced with double hyphens (--), Unicode arrows (→) replaced with ASCII (-->).
  • Version in CLI reference block updated from v0.7.3 to v0.7.4 to match actual current version.

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.md to 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> --help and hcom config <key> --info; also updates the displayed version to v0.7.4 and 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.


Open with Devin

Co-Authored-By: Anno Gomes <annogomes@gmail.com>
@aannoo aannoo closed this Mar 13, 2026
@aannoo aannoo deleted the devin/1773379730-new-readme branch March 13, 2026 05:40
Copy link
Copy Markdown
Owner Author

@aannoo aannoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

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