docs(readme): publish the stable install path - #48
Merged
Conversation
Replace the two-step tap instructions with Homebrew's one-command cask install and remove the pre-release notice now that stable releases are published. Keep the wording tied to the latest stable release so automated version bumps do not make the README stale again.\n\nRequirements: REQ-17.2, REQ-8.5
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.
Summary
Updates the README now that
v0.1.0is published and the Homebrew cask points to the stable release. Replaces the two-step tap/install sequence with the supported one-command installation and removes the stale pre-release notice.Spec task: tasks.md task 32.1 — Rewrite the README for a public audience.
Requirements covered
Correctness properties
None.
Deliberately not covered
No release assets, cask configuration, or product behavior change.
Verification
v0.1.0releaseolamide226/homebrew-tap/Casks/avar.rbis version0.1.0No release, future-install, two-step tap, and hard-codedv0.1.0wordinggit diff --checkmake e2e— not run: documentation-only changeNotes for review
The README says
latest stable releaserather than hard-codingv0.1.0, so future automated releases do not immediately make the installation section stale. Thedocs:commit type intentionally does not trigger a semantic release.