docs: rewrite README and add CLAUDE.md#23
Merged
Merged
Conversation
README rewrite
- The previous README read like internal documentation. This rewrite
positions the project for visibility:
- Adds a row of badges (CI, Go Report Card, latest release,
pkg.go.dev, license) so legitimacy signals are visible above the
fold.
- Leads with a single-sentence value proposition and the existing
demo GIF.
- Adds a "Why terraform-demux?" hook and a Features section that
surfaces the non-obvious wins: checksum verification, per-binary
flock, TF_DEMUX_ARCH on Apple Silicon, the state-command guard,
cross-platform support.
- Adds a comparison table vs. tfenv and tfswitch.
- Promotes env vars to a table and documents TF_DEMUX_CACHE_HOME and
the TF_DEMUX_* env-stripping behavior. Active-voice rewrite of the
state-command guard section. Links to the corresponding
import/moved/removed Terraform docs for each refused command.
- Keeps every factual claim from the previous README; nothing dropped.
CLAUDE.md
- Add a previously-untracked CLAUDE.md describing the project layout,
env vars, architecture, CI, and release flow for future automated
contributors. Reflects the post-merge state: the build-tagged
signals/exitcode files, the SetupLogging API, the refactored
download path (findBuild / verifyChecksum / openZipReader /
extractTerraformBinary), the cross-platform CI matrix with -race,
the goreleaser ldflags injection, and the deploy-key bypass for the
Homebrew formula publish.
c4po
changed the title
manuelruizetc
approved these changes
May 6, 2026
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
2 participants
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.
Why
The previous README was functional but read like internal docs — one-line tagline, install steps, env vars. It buried the project's strongest selling points and had no badges, no comparison to alternatives, and no compelling "why does this exist?" hook.
What's new (README)
Also (CLAUDE.md)
What's preserved
Test plan