docs(readme): refresh for v0.6→v0.8, add MCP tool map#19
Merged
Conversation
Restructure the root README onto the shared bare-ecosystem skeleton and bring it current with the last three releases: - Lead names both run modes (Docker + npx); new "Two ways to run" table contrasts Container vs Lite and states the single-file version-parity guarantee. Retitle Quick start (container) / Lite mode (npx); drop the now-redundant inline comparison table. - New "The MCP" section maps all 12 verbs (Read/triage · Write/act · Watch/reach), surfacing the previously undocumented poll_messages watch primitive + restart-safe cursor + source echo-guard (0.6.0) and attachments[] + download_asset byte reach (0.7.0). - Bump stale BEEPERBOX_IMAGE_TAG pin 0.7.0 -> 0.8.0. - Repoint mcp/README.md cross-links to the renamed anchors (#quick-start-container, #lite-mode-npx); keep it a focused lite-mode landing page, not a copy of the full README. - CHANGELOG: record under [Unreleased] / Documentation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
hamr0
added a commit
that referenced
this pull request
Jun 17, 2026
PATCH per the versioning policy — docs only; the MCP/HTTP surface, schemas, and ports are bit-identical to v0.8.0. Ships the README refresh (root #19, npm-page #20) under a new version because npm versions are immutable and the reshaped lite-mode README only reaches npmjs.com via a fresh publish. - mcp/package.json 0.8.0 -> 0.8.1 (keeps npm == container == serverInfo.version) - mcp/package.json homepage anchor -> #lite-mode-npx - CHANGELOG [Unreleased] -> [0.8.1] 2026-06-17 [PATCH] Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Refreshes the root README to reflect the last three releases and restructures it onto the shared
bare-ecosystem skeleton.What changed
npx; a new Two ways to run table contrasts Container vs Lite (where Beeper lives, deps, start command, first-run login) and states the same-single-file version-parity guarantee.Quick start/Lite moderetitled Quick start (container) / Lite mode (npx); the now-redundant inline comparison table dropped.poll_messageswatch primitive + restart-safe cursor +sourceecho-guard (0.6.0) andattachments[]+download_assetbyte reach (0.7.0).BEEPERBOX_IMAGE_TAG=0.7.0→0.8.0.mcp/README.mdkept as a focused lite-mode landing page (intentionally not a copy of the full README); its two cross-links repointed to the renamed anchors (#quick-start-container,#lite-mode-npx).[Unreleased]/ Documentation.Docs-only; no runtime/version change.
🤖 Generated with Claude Code