Readme Update - #7
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR rewrites the README to reposition tunmux as an “install once, forget about it” always-on split-tunnel WireGuard client for macOS, with a simpler installation-first narrative and a tighter description of how the privileged daemon + login agent work together.
Changes:
- Replaces the previous feature/CLI reference-heavy README with a “Why / How it works” conceptual overview.
- Documents
make install TUNMUX_PROFILE=...as the primary setup flow, including launchd components and privilege boundary. - Simplifies requirements/build/development sections to match the new onboarding approach.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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
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.
No description provided.