docs: add Homebrew install path to README#44
Closed
lukeocodes wants to merge 2 commits intomainfrom
Closed
Conversation
Adds 'macOS / Linux (Homebrew)' as the first option under Quick Install: brew install deepgram/tap/deepgram Documents that Homebrew handles ffmpeg + portaudio automatically (covers dg listen --mic, dg debug probe, raw audio piping) and notes brew upgrade deepgram for updates. Companion to deepgram/homebrew-tap#1 (formula) and #42 (release-automation that keeps the formula fresh).
Switches the README's Homebrew snippet from the one-shot brew install deepgram/tap/deepgram to the two-step brew tap deepgram/tap brew install deepgram After tapping, future installs and upgrades use the bare formula name (brew upgrade deepgram), which is what users will most often see and type. The two-step form is also more explicit about what's being tapped.
Member
Author
|
Folded into #42 so all the Homebrew-tap-related changes for deepgram/cli ship as a single review unit. |
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
Adds Homebrew as the first option under Quick Install in the README:
Notes that Homebrew handles
ffmpeg+portaudioautomatically (coversdg listen --mic,dg debug probe, raw audio piping) and that future updates usebrew upgrade deepgram.Why
Companion to deepgram/homebrew-tap#1 (the formula) and deepgram/cli#42 (release-automation that keeps the formula fresh). Brew is now the canonical low-friction install path for Mac/Linux developers — sits at the top of "Quick Install" alongside the curl one-liner.
Diff
README.md: 9 lines added, 1 modified. Just the Homebrew block under Quick Install — no other sections touched.Companion docs PR
deepgram/deepgram-docs#834 — same content updated on the docs site's CLI install page (also fixes a stale
deepgram-cliformula-name reference and removes a "if you have a custom tap configured" conditional).