From 1f7238a1611b7b9cb0bd1bc95e263e498a583274 Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Mon, 24 Feb 2025 09:06:31 -0500 Subject: [PATCH 1/3] docs: add homebrew installation note Signed-off-by: Rui Chen --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 609d16e..2c7f93c 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,14 @@ Any of these will work: 1. ```shell cargo install --git https://github.com/yshavit/mdq + + # Homebrew + 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 +1. Download binaries from [the latest release] (or any other release, of course). +1. 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. - +
Security concerns The release and latest-workflow binaries are built on GitHub's servers, so if you trust my code (and dependencies), and you trust GitHub, @@ -141,7 +144,7 @@ TICKET_URL="$(echo "$PR_TEXT" This will match Markdown like: > #### Ticket -> +> > https://tickets.example.com/PROJ-1234 ### Whittling down a big table From f1a02567eb8c3fb68c71bcf9fbd42f1a5c7d66ff Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Mon, 24 Feb 2025 09:10:31 -0500 Subject: [PATCH 2/3] fix: update cargo.lock Signed-off-by: Rui Chen --- Cargo.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.lock b/Cargo.lock index 3993dd7..59b4ca0 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -176,7 +176,7 @@ dependencies = [ [[package]] name = "mdq" -version = "0.1.0" +version = "0.3.0" dependencies = [ "clap", "indoc", From 786c6d4870af4998ae065587c5e0f4995d4b040b Mon Sep 17 00:00:00 2001 From: Yuval Shavit Date: Thu, 27 Feb 2025 23:13:48 -0500 Subject: [PATCH 3/3] Apply suggestions from code review --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 038e988..455a40a 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,11 @@ Any of these will work: 1. ```shell cargo install --git https://github.com/yshavit/mdq - - # Homebrew +2. ```shell brew install mdq ``` -1. Download binaries from [the latest release] (or any other release, of course). -1. 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.