Skip to content

docs: surface ClawHub traction (1.1K downloads) in README - #2

Closed
berriosb wants to merge 1 commit into
mainfrom
docs/readme-clawhub-traction
Closed

berriosb wants to merge 1 commit into
mainfrom
docs/readme-clawhub-traction

Conversation

@berriosb

@berriosb berriosb commented Jun 25, 2026 •

Copy link
Copy Markdown
Owner

Why

The README was technically correct but did not surface the main social proof: 1.1K+ downloads on ClawHub. A recruiter or agent author landing on the repo sees a plain technical intro with no signal of traction.

What changed

  • Hero badge linking to ClawHub skill page with download count
  • New Why it matters section (problem -> solution, for non-technical readers)
  • New Traction table with real ClawHub metrics (downloads, version, last updated, stars)
  • Badges block: downloads, license, ACP/JSON-RPC, OpenCode, Python, CI
  • Quick start now lists ClawHub install as recommended path
  • Documented real JSON-RPC method flow (initialize -> session/new -> prompt -> update -> cancel -> load)
  • Author block at the end with hakke.cl / ClawHub / GitHub links

Scope

  • 1 file: README.md (+142 / -46)
  • No code changes, no CI changes, no SKILL.md changes

Risk

Low. README only. No functional change to the skill or the demo script.

Links

Summary by CodeRabbit

  • Documentation

    • Reworked the README into a clearer, more structured guide with concise overview, capabilities, setup, local testing, and usage sections.
    • Added a repository layout, CI/quality checklist, contribution guidance, and updated author/license details.
    • Expanded installation and demo instructions, including step-by-step examples for trying the skill locally.
  • New Features

    • Added clearer end-to-end usage guidance for starting, monitoring, resuming, canceling, and updating sessions through the supported protocol.

- Add hero with 1.1K+ downloads badge linking to ClawHub skill page
- Reorganize intro: tagline + 'Why it matters' for non-technical readers
- Add 'Traction' table with ClawHub metrics (downloads, version, date)
- Add badges (downloads, license, ACP/JSON-RPC, OpenCode, Python, CI)
- Document real JSON-RPC method flow (initialize -> session/new -> prompt -> update -> cancel -> load)
- Add author block with hakke.cl / ClawHub / GitHub links
- Quick start now shows ClawHub install as recommended path
@coderabbitai

coderabbitai Bot commented Jun 25, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

The README was reorganized into structured sections covering the skill description, capabilities, install and demo steps, ACP/JSON-RPC method mapping, repository layout, CI checks, contributing guidance, author links, and license reference.

Changes

README restructure

Layer / File(s) Summary
Overview and positioning
README.md
The README header, skill description, capability list, and traction summary are rewritten into a structured overview.
Usage and protocol
README.md
Install instructions, local demo commands, requirements, ACP/JSON-RPC method mapping, and agent tool names are updated together.
Repository and maintenance
README.md
Repository layout, CI gates, contributing steps, author information, and the license reference are rewritten.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through badges, bright and new,
ACP frames now read so true.
Paths and gates in tidy rows,
Even my carrot clap just glows.
Hop, hop — the README sings anew!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main README change: surfacing ClawHub traction and downloads.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-clawhub-traction

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@berriosb berriosb closed this Jun 25, 2026
@berriosb
berriosb deleted the docs/readme-clawhub-traction branch June 25, 2026 01:52

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7aaf317506

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
# Load as skill (Hermes Agent)
# Option A — copy into the active profile's skills dir
# Hermes Agent — copy into the active profile's skills dir
cp SKILL.md ~/.hermes/profiles/<profile>/skills/opencode-acp-control.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore a checkout step before copying SKILL.md

For the Hermes install path, a user following the README from GitHub no longer has a local checkout before this cp SKILL.md ... command—the clone/cd lines that previously created it were removed—so the quick start fails with cp: cannot stat 'SKILL.md'. Add a clone/download step, or show a raw download command, before the copy instructions.

Useful? React with 👍 / 👎.

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