Skip to content

docs: promote Homebrew to primary installation path across docs and website - #160

Merged
jatinkrmalik merged 1 commit into
mainfrom
feat/homebrew-primary-install
Jun 12, 2026
Merged

docs: promote Homebrew to primary installation path across docs and website#160
jatinkrmalik merged 1 commit into
mainfrom
feat/homebrew-primary-install

Conversation

@jatinkrmalik

Copy link
Copy Markdown
Member

Summary

  • Homebrew is now the recommended and primary installation method across all documentation and the marketing website
  • Website hero section gets a "Quick Install" button that reveals a copyable terminal with brew commands
  • All installation ordering is consistent: Homebrew → DMG → Build from Source

Changes

README.md

  • Quick Start reordered: Option 1 = Homebrew (Recommended), Option 2 = Download DMG, Option 3 = Build from Source, Option 4 = CLI Commands
  • Nightly section: added brew install --cask vocamac-nightly as the recommended method
  • Requirements: updated DMG-specific language to be method-agnostic

Website (web/)

  • Hero section: added "Quick Install" button that, when clicked, reveals a mini terminal with brew tap jatinkrmalik/vocamac && brew install --cask vocamac and a copy button
  • Install section: three tabs now — 🍺 Homebrew (default/active), 📦 Download DMG, 🛠️ Build from Source
  • Install tab JS: updated switchInstallTab to handle three tabs, added toggleQuickInstall and copyQuickInstall functions
  • FAQ: "How do I update?" now mentions both Homebrew and DMG paths
  • CSS: added .hero__quick-install and .hero__quick-install-hint styles
  • Feature pages: updated github-release-updates.md to mention Homebrew update flow; updated smart-model-selection.md to remove DMG-specific language

Docs

Files Changed

File Changes
README.md +29/-6
web/layouts/index.html +125/-14
web/static/style.css +13
web/content/features/github-release-updates.md +8/-4
web/content/features/smart-model-selection.md +1/-1
docs/ARCHITECTURE.md +18/-3
docs/HOMEBREW.md +4/-3

No Swift source code changes — the in-app Homebrew detection and update flow (PR #159) already handles this correctly.

- README: reorder Quick Start — Homebrew (#1), DMG (#2), Build from Source (#3)
- README: add brew install instructions to Nightly section
- Website hero: add Quick Install button with copyable terminal
- Website install: Homebrew as default tab, DMG/secondary, Build from Source/tertiary
- Website JS: toggleQuickInstall, copyQuickInstall, updated tab switcher
- Website subpages: update github-release-updates and smart-model-selection
- CSS: add hero quick-install terminal styles
- ARCHITECTURE.md: swap distribution strategy order, document Homebrew update flow
- docs/HOMEBREW.md: add recommended banner and update overview
@jatinkrmalik
jatinkrmalik force-pushed the feat/homebrew-primary-install branch from e15df76 to 0c74b7d Compare June 12, 2026 21:08
@jatinkrmalik
jatinkrmalik merged commit ffaea7a into main Jun 12, 2026
3 checks passed
@jatinkrmalik
jatinkrmalik deleted the feat/homebrew-primary-install branch August 22, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant