Explain local IPC before the README visual demos - #24
Merged
Merged
Conversation
- Lead with the existing pool definition and preserve the author’s principles and guidance in a clearer reading order. - Replace aligned HTML examples with copyable local and remote commands, including late-reader history and explicit server/reader transitions. - Add an editable file-sharing diagram and a real released-1.0 terminal recording, with transcript, still images, and reproduction instructions. - Move the existing live map to inspection and retain platform, retention, access-key, and snapshot limits. - Validate the full just check gate, local links, captured frames, desktop and narrow layouts, and independent editorial review.
- Explain bounded history before introducing the ring buffer term. - Bind both listeners to loopback in the local browser example, using the released 1.0 command. - Defer the Windows benchmark link until its separately preserved report lands.
sandover
marked this pull request as ready for review
October 2, 2026 19:49
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.
The README now explains local pools and gives an installation path and working IPC example before introducing optional browser, remote, and MCP access. It retains the original principles and Alice/Bob/Carol examples, adds practical boundaries, and describes the released 1.0 snapshot and locking model.
Add an editable pool diagram and a reproducible terminal recording made with released Plasmite 1.0.0. Move the existing live map GIF into the browser section, keep it unchanged, and offer still-image links. The local browse command binds both listeners to loopback.
Validation:
just release-gatepassed on this branch, includingjust check, integration, bindings, conformance, and wheel smoke./ui/mapat the documented URL; running server status confirmed both loopback addresses.The branch contains only README/media changes and their recording script. The Windows benchmark work remains on its separate local branch; its report link is deferred. No release tag or publication accompanies this change.