Skip to content

docs: reconcile README with session-peer 0.6.0 - #54

Merged
abruption merged 1 commit into
mainfrom
docs/53-readme-refresh
Sep 11, 2026
Merged

abruption merged 1 commit into
mainfrom
docs/53-readme-refresh

Conversation

@abruption

Copy link
Copy Markdown
Owner

Summary

Reconcile README.md with the released session-peer 0.6.0 CLI and completed legacy migration. Documentation only; no command, transport, packaging or installation behavior changes.

Closes #53

  • Move badges and a shared quick start to the top. Explain default Claude selection, --agent codex (not --codex), full codex: targets and saved-thread versus live-session state.
  • Correct remote update/check semantics, local-version comparison and possible downgrade, standalone/skill paths, package-manager upgrades and remote package-manager limitations.
  • Record cc-peer's final release and PyPI archival while preserving explicit migration, downloadable artifacts and active GitHub history.
  • Separate Claude-only guidance from common behavior and Codex contracts. Correct JSON/exit-code descriptions without changing the existing schema.
  • Replace overstated coverage with the actual suite/CI matrix and Test the parts the docs call fragile: discover(), the socket payload, exit codes #28 gaps; distinguish historical Claude end-to-end results from v0.6 submission-only evidence.

Type

  • feat
  • fix
  • docs
  • chore / refactor / test / perf

Checklist

  • Local session_peer.py list / list --agent codex JSON validated (legacy template command intentionally replaced with current product).
  • session_peer.py list --host <real host> --json checked against an existing Linux SSH destination; read-only discovery.
  • Codex --dry-run resolved a saved local target without posting/queueing.
  • Commits follow Conventional Commits.
  • README matches existing behavior; SKILL.md and CLI unchanged.
  • No secrets, tokens, session keys or actual session IDs in the diff.

Verified against

  • python3 -m unittest discover -v: 134 tests passed.
  • All 10 bash fences passed sh -n; 25 CLI examples parsed using the actual argparse parser without executing the examples. Default selection and rejected --codex checked explicitly.
  • Internal heading anchors/local file links and git diff --check passed.
  • Current session_peer.py v0.6.0 and .github/workflows/ci.yml used to check documented semantics and CI coverage.
  • Existing official Claude messaging/Remote Control links opened to check the shortened Claude-specific guidance.

Notes

No live messages sent, no inbound settings changed, no remote installs/updates run. Historical receiving-turn tests are labeled as historical; the v0.6 queue checks are not represented as acknowledgements. This PR does not implement or close #28, #29 or #31.

This updates the GitHub README; already-published PyPI distribution metadata is not republished as part of a documentation-only PR.

@abruption
abruption merged commit 48373ed into main Sep 11, 2026
9 checks passed
@abruption
abruption deleted the docs/53-readme-refresh branch September 18, 2026 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant