docs(readme): replace packaging roadmap with install instructions - #36
Merged
Conversation
The Factory submission was accepted at 0.2.0 (SR 1368198), so the Roadmap entry promising openSUSE packaging is stale. Replace the "Installation / build" section with an Installation section covering zypper (Tumbleweed; Leap 16.x and Slowroll via devel:tools), cargo install from crates.io, and building from source, and document what the package installs: worked-example policy.toml and audit.toml under /etc/bugwarden as %config(noreplace), neither loaded implicitly. Add the --audit-config / BUGWARDEN_AUDIT_CONFIG row missing from the CLI reference table, so the Installation section does not cite a flag the table omits. Delete the Roadmap section; that entry was its only item. Fixes #30.
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.
Fixes #30.
What changed
The README's Roadmap section listed openSUSE packaging as future work. Both gates named in the issue have cleared: the Factory submission was accepted on 2026-07-28 (SR 1368198), and it went in at 0.2.0 directly, so distribution users get the current guard behaviour from the start. The Roadmap entry is replaced by real installation instructions, and the Roadmap section is deleted (it was the only entry).
The former "Installation / build" section becomes Installation with three routes:
sudo zypper install bugwardenon Tumbleweed; Leap 16.x and Slowroll builds via thedevel:toolsOBS project. Documents what the package installs:/etc/bugwarden/policy.tomland/etc/bugwarden/audit.toml, both worked examples marked%config(noreplace), and states that neither is loaded implicitly — a policy only via--policy/BUGWARDEN_POLICY, an audit configuration only via--audit-config/BUGWARDEN_AUDIT_CONFIG.cargo install bugwarden, noting that unlike the package it ships no configuration files, so a packaged install and a cargo install are not documented as if they were the same thing (the issue's explicit ask).Adversarial review (before this PR)
One hostile docs-vs-reality review over the diff, every factual claim checked against primary sources: the Factory spec (both config files installed from
examples/,%config(noreplace), the/etc/bugwardendirectory owned), OBS build and publish state (the 0.2.0 RPM is live in the published Tumbleweed oss repo, so the zypper command works today; Leap 16.0/16.1 and Slowroll builds in devel:tools succeeded and are published), crates.io (bugwarden0.2.0, not yanked,bin_names: ["bugwarden"]), and the flag definitions inconfig.rs/main.rs(nothing auto-loads/etc/bugwarden— the "neither is loaded implicitly" claim is code-verified).No majors. One content finding, fixed in this PR: the Installation section cited
--audit-configwhile the README's CLI reference table omitted the flag — a pre-existing gap (the table never gained a row when the audit feature shipped, and Installation is the README's first mention of audit at all). The missing row is added so the README agrees with itself; wording mirrorsdocs/DESIGN.mdand theconfig.rsdoc comment. The reviewer also confirmed the deleted Roadmap bullet is exactly what the new section delivers, and that nothing anywhere in the repo links to the removed section or the old "Installation / build" heading anchor.Verification
Docs-only diff (README.md). On the branch:
typos,cargo fmt --check,cargo clippy --workspace --all-targets -- -D warnings,cargo test --workspace --all-targets --locked(265 passed, 0 failed),cargo deny check(advisories/bans/licenses/sources ok). Claims verified against primary sources: the Factory spec (osc cat openSUSE:Factory bugwarden bugwarden.spec— both config files,%config(noreplace)), Factory and devel:tools build results, crates.io (bugwarden0.2.0 published), andcrates/bugwarden/src/config.rsfor the exact flag spellings.