Skip to content
This repository was archived by the owner on Aug 8, 2026. It is now read-only.

docs: Matron context in README + Matron-specific CONTRIBUTING - #2

Merged
danbarker merged 2 commits into
mainfrom
docs/public-readme
Aug 8, 2026
Merged

danbarker merged 2 commits into
mainfrom
docs/public-readme

Conversation

@danbarker

@danbarker danbarker commented Jul 13, 2026 •

Copy link
Copy Markdown

Changes

README.md

  • Add an opening paragraph explaining what Matron is (a chat system for talking to Claude Code agents from your phone, desktop, or browser) and that this repo is the Matrix homeserver used by Matron's Matrix transport. The existing Tuwunel tracking/naming explanation is kept.
  • Ecosystem table: add rows for matron-journal (sync server for Matron's native journal transport) and claude-matrix-bridge (runs Claude Code sessions and bridges them to Matrix and the journal).
  • Fix broken iOS link: matron-ios (404) -> matron-iOS-app. All other table links verified against live repos.
  • Add a "Build from source" section (cargo build --release, binary at target/release/tuwunel) with a pointer to upstream Tuwunel docs.

CONTRIBUTING.md

  • Replace unmodified upstream Tuwunel content (Tuwunel Matrix room, maintainer email, sr.ht mirrors) with a short Matron-specific guide: contributions via GitHub issues/PRs on Matronhq/matron-server, an "upstream first" note pointing substantive server changes at Tuwunel, and the retained Apache-2.0 licensing agreement clause.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes with no runtime, security, or data-handling impact.

Overview
README now opens with what Matron is and how this repo fits the Matrix transport (including claude-matrix-bridge). The ecosystem table adds Matron Journal and claude-matrix-bridge, normalizes GitHub org links to Matronhq, and points iOS at matron-apple. A new Build from source section documents cargo build --release and target/release/tuwunel, with a link to upstream Tuwunel docs.

CONTRIBUTING is replaced with a short Matron guide: GitHub issues/PRs on Matronhq/matron-server, an upstream first policy for server behavior vs. fork-only work (docs/packaging/releases), nightly cargo fmt and lints, and Apache-2.0 / Code of Conduct—removing the long upstream Tuwunel room, Complement/mdbook maintainer detail, and mirror/stale-branch policies.

Reviewed by Cursor Bugbot for commit 4050b39. Bugbot is set up for automated code reviews on this repo. Configure here.

danbarker and others added 2 commits July 13, 2026 12:38
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The iOS/macOS client repo was renamed matron-iOS-app -> matron-apple
(it's the native Apple client for both iOS and macOS, distinct from the
Electron matron-desktop). GitHub redirects the old URLs, but update the
links to the canonical name.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@danbarker
danbarker merged commit 6eae326 into main Aug 8, 2026
2 checks passed
@danbarker
danbarker deleted the docs/public-readme branch August 8, 2026 10:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant