Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add homebrew installation note #215

Merged
merged 4 commits into from
Feb 28, 2025
Merged

docs: add homebrew installation note #215

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f7238a
docs: add homebrew installation note
chenrui333 Feb 24, 2025
f1a0256
fix: update cargo.lock
chenrui333 Feb 24, 2025
127440d
Merge branch 'main' into installation
yshavit Feb 28, 2025
786c6d4
Apply suggestions from code review
yshavit Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,13 @@ Any of these will work:

1. ```shell
cargo install --git https://github.com/yshavit/mdq
2. ```shell
brew install mdq
```
2. Download binaries from [the latest release] (or any other release, of course).
3. You can also grab the binaries from the latest [build-release] workflow run. You must be logged into GitHub to do
3. Download binaries from [the latest release] (or any other release, of course).
4. You can also grab the binaries from the latest [build-release] workflow run. You must be logged into GitHub to do
that (this is GitHub's limitation, not mine). You'll have to `chmod +x` them before you can run them.

<details>
<summary>Security concerns</summary>
The release and latest-workflow binaries are built on GitHub's servers, so if you trust my code (and dependencies), and you trust GitHub,
Expand Down Expand Up @@ -141,7 +143,7 @@ TICKET_URL="$(echo "$PR_TEXT"
This will match Markdown like:

> #### Ticket
>
>
> https://tickets.example.com/PROJ-1234

### Whittling down a big table
Expand Down
Loading