docs(readme): refresh badges + shipped/limitations sections for 1.0 - #55
Merged
Conversation
The README's `Shipped Commands` table was missing four commands that landed in 2026-05, and the `In Progress` table claimed five features were "Planned" / "Experimental" when they had actually shipped. ## Shipped Commands — added 4 - `set-up` (PR-6a/6b/6c — lifecycle hooks against an existing container + dotfiles + `/etc` patches) - `upgrade` (PR-5a/5b — regenerate-lockfile + Dependabot pinning) - `outdated` (current/wanted/latest feature versions) - `config` (config management subcommands) Also rewrote one-liners for the existing commands to be more accurate (e.g. `up` notes features-at-build-time, `build` notes the Dockerfile-only feature scope, `read-configuration` mentions extends + variable substitution). ## In Progress → Known limitations The old table claimed these five were not ready, all wrong now: - Docker Compose profiles → shipped (`populate_profiles` in `compose.rs`) - Features during `up` → shipped (PR-4a/4b/4c) - Container-side dotfiles → shipped (PR-6b) - `--expect-existing-container` → shipped (`container.rs:435` + `compose.rs:146`) - Port forwarding → shipped (`forward_ports` flows through both paths) Replaced the whole table with two honest entries: - **Podman runtime** — still experimental in 1.0; #30 tracks 1.1 - **`build` features** — Dockerfile-only; compose-build + image-ref still error with features Footer now points at #52 (post-1.0 hardening tracker) too. ## Badges — added 4 Existing: Latest Release, CI status, License. Added: - CodeQL workflow status (new in PR #47) - Coveralls coverage badge (matches the "Coverage is published to Coveralls" line later in the README) - MSRV 1.82 (bumped in PR #26) - Security Policy badge linking to GH security policy (SECURITY.md landed in PR #47) Also pinned the CI badge to `?branch=main` so a feature-branch failure doesn't flap the README. ## Code Signing section Removed the false "tracked in issue: Code Signing" claim — no such issue exists. Replaced with a "file one if you need this prioritized" note so readers know it's not actively scheduled. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
1 participant
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.
The README's
Shipped Commandstable was missing four commands that landed in 2026-05, and theIn Progresstable claimed five features were "Planned" / "Experimental" when they had actually shipped.Shipped Commands — added 4
set-up(PR-6a/6b/6c — lifecycle hooks against an existing container + dotfiles +/etcpatches)upgrade(PR-5a/5b — regenerate-lockfile + Dependabot pinning)outdated(current/wanted/latest feature versions)config(config management subcommands)Also rewrote one-liners for the existing commands to be more accurate.
In Progress → Known limitations
The old
In Progresstable claimed these five were not ready, all wrong now:populate_profilesincompose.rs)up→ shipped (PR-4a/4b/4c)--expect-existing-container→ shipped (container.rs:435+compose.rs:146)forward_portsflows through both paths)Replaced with two honest entries:
buildfeatures — Dockerfile-only; compose-build + image-ref still error with featuresFooter now also points at #52 (post-1.0 hardening tracker).
Badges — added 4
Existing: Latest Release, CI status, License. Added:
Also pinned the CI badge to
?branch=mainso a feature-branch failure doesn't flap the README.Code Signing section
Removed the false "tracked in issue: Code Signing" claim — no such issue exists. Replaced with a "file one if you need this prioritized" note.
🤖 Generated with Claude Code