Skip to content

Describe herdr, agents and the current app in the README - #237

Merged
h3nock merged 1 commit into
mainfrom
docs/readme-refresh
Nov 11, 2026
Merged

h3nock merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@h3nock

@h3nock h3nock commented Nov 11, 2026 •

Copy link
Copy Markdown
Owner

The README described the tmux-only app from August. This brings it up to date with herdr, agents and the app as it is on main.

What changes

  • The tagline becomes "A native iOS client for tmux and herdr.", matching getremux.app.
  • About says what Remux does and what sets it apart, in two sentences.
  • Features is one short line each for the ten things people look for first, now including herdr, the Agents list, Tailscale SSH and choosing the toolbar keys. It drops Themes, which people find in Settings.
  • It corrects two claims. Live previews are in the tmux Windows sheet, not the pane picker. Building needs Xcode 26 or later, because dictation uses the iOS 26 SDK, so "Xcode with iOS 18 SDK support" doesn't work.
  • New Requirements and License sections. Acknowledgments drops "uses".
  • The 2 Aug video stays until the new recording.

Validation

  • Each feature line was checked against the source on main, with file and line references.
  • The build steps were run on a clean copy of main (53b4de6) with the default Xcode 27.0. scripts/fetch_ghosttykit.sh, xcodegen generate and the simulator build all succeed, and the test command's iPhone 17 destination exists (iOS 27.2). The test suite itself runs in CI.

Summary by CodeRabbit

  • Documentation
    • Updated the README with an overview of Remux’s iOS features, server requirements, installation and build guidance, and supported Xcode version.
    • Added an MIT license statement and revised the project acknowledgments.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-11T23:46:45.471936Z e1a7845 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README now describes Remux as an iOS client for tmux and herdr. It updates the feature list, server requirements, installation and build information, acknowledgments, and license reference.

Changes: README update

Layer / File(s) Summary
Product and setup documentation
README.md
The README updates the product description and features. It states iOS and server requirements, revises installation and build information, and adds an MIT license reference.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: Minimal · up to e1a78

This updates the README text only and does not change runtime behavior. It carries no meaningful merge risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the README update and its focus on herdr, agents, and the current app. The raw summary confirms the README now describes Remux as an iOS client for tmux and herdr, with feature descrip…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the README update and its focus on herdr, agents, and the current app. The raw summary confirms the README now describes Remux as an iOS client for tmux and herdr, with feature descriptions for herdr sessions, agents, and related items. The title covers the main change, though it does not mention the requirements, license, or acknowledgment edits. The phrase 'the current app' is somewhat broad, but the title is still specific enough for a teammate to identify the primary change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 69701ad8-e38c-4539-8c27-60d8eda0776b
Commits

Reviewing files that changed from the base of the PR and between 53b4de6 and e1a7845.

Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

@h3nock
h3nock merged commit 253288f into main Nov 11, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant