Skip to content

docs: rewrite npm package description and README - #119

Merged
quickbeard merged 2 commits into
mainfrom
npm-readme
Jul 22, 2026
Merged

quickbeard merged 2 commits into
mainfrom
npm-readme

Conversation

@quickbeard

Copy link
Copy Markdown
Owner

Summary

The published codev-code npm page had a placeholder description ("Just another AI agent harness") and a one-line README. Both live only in packages/opencode/script/publish.ts, which synthesizes the published package at release time.

  • Description now reads: "AI coding agent for the terminal — an opencode fork with its own fixes and features".
  • README now covers what the tool is, install (npm install -g codev-code, platform-binary postinstall, codev command), basic usage (codev, codev --help, codev run "..."), and links to the docs site, this repo, and upstream.
  • Added an Unreleased changelog entry under Packaging.

No DIVERGENCES.md change: the existing publish.ts row already covers the embedded README/description generically. The new text reaches npm on the next bun release.

🤖 Generated with Claude Code

The published codev-code npm page had a placeholder blurb. It now
describes what the tool is, how to install and run it, and links the
docs site, the fork repo, and upstream. No DIVERGENCES.md change: the
existing publish.ts row already covers the embedded README/description.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@quickbeard
quickbeard merged commit dc94d23 into main Jul 22, 2026
0 of 5 checks passed
@quickbeard
quickbeard deleted the npm-readme branch July 22, 2026 01:26
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