Skip to content

docs: alpha notice + Homebrew install - #79

Merged
afitzgerald merged 1 commit into
mainfrom
alan/readme
Sep 5, 2026
Merged

afitzgerald merged 1 commit into
mainfrom
alan/readme

Conversation

@afitzgerald

Copy link
Copy Markdown
Owner

Summary

  • Adds an alpha-status warning at the top of the README ahead of making the repo public
  • Adds a Homebrew install section (brew install --cask afitzgerald/diffier/diffier), matching the cask already published by release.yml
  • Renames the old "Running" section to "Running from source" to distinguish it from the Homebrew path

Test plan

  • Reviewed rendered README locally

Public release makes the README the first thing new users see, so it
needs to set expectations (alpha, use at your own risk) and cover the
Homebrew cask that's already published by the release workflow.
@afitzgerald
afitzgerald merged commit 3d14149 into main Sep 5, 2026
1 check passed
@afitzgerald
afitzgerald deleted the alan/readme branch September 5, 2026 17:17
afitzgerald added a commit that referenced this pull request Sep 30, 2026
docs: alpha notice + Homebrew install
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant