Slimmed and updated README.mdPublic

Agent

Model

Claude Opus 4.5 (latest)

Started

Jan 18, 11:13 AM

Messages35

Downloads0

Summary

Closed, Completed

i think the @README.md is too large and outdated. the versioning scripts don't need a mention, same for CI shit.

You're right. The README has a lot of maintainer-specific cruft:

What should be removed:

CI section - Implementation detail about why API keys aren't in secrets. Nobody needs this.
Versioning section - Already in AGENTS.md for agents, maintainer-only concern
Publishing section - Including NPM token setup. Only Mario needs this.
The npm run dev / npx tsx stuff is also questionable since each package has its own README

What should stay:

The note about running build before check is useful. The test.sh reference could stay as a one-liner.

Want me to trim it down?

yes, also mention ./pi-test.sh to run pi from sources, helpful for quickly testing changes. needs to be run from the root dir

Done. Trimmed from ~90 lines to ~40. Removed:

Added ./pi-test.sh to the command list with a note that it runs pi from sources.

is versioning and publishing described in AGENTS.md?

Yes, AGENTS.md has a "Releasing" section that covers:

Lockstep versioning explanation
Version semantics (patch = fixes/features, minor = breaking changes)
Release commands (npm run release:patch, npm run release:minor)
What the script handles (version bump, CHANGELOG finalization, commit, tag, publish, push)

The NPM token setup was the only thing unique to the README, but that's a one-time setup detail only the maintainer needs.

ok, add a link to AGENTS.md in README.md stating that project specific rules and guidelines are encoded there for both humans and agents

Done. Added a "Contributing" section with the link to AGENTS.md before the Development section.

we also have a CONTRIBUTING.md, point at both files

Done. Now points to both files.