From ccc0e80262b151b86be97af3bcaa955c584d841f Mon Sep 17 00:00:00 2001
From: RB <7775707+nitrocode@users.noreply.github.com>
Date: Sun, 10 Nov 2024 03:48:11 -0600
Subject: [PATCH] ci: add homebrew action and docs (#735)

* ci: add homebrew step

* docs: add brew install

* fix: address feedback
---
 .github/workflows/release.yml | 13 +++++++++++++
 README.md                     | 15 ++++++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index bb4f2a9..796ac3a 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -55,3 +55,16 @@ jobs:
         if: ${{ steps.release.outputs.release_created }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  homebrew:
+    name: "Bump Homebrew formula"
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - uses: mislav/bump-homebrew-formula-action@b3327118b2153c82da63fd9cbf58942146ee99f0 # v3
+        with:
+          # A PR will be sent to github.com/Homebrew/homebrew-core to update this formula
+          formula-name: action-docs
+          formula-path: Formula/a/action-docs.rb
+        env:
+          COMMITTER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
index b7b3fc8..00f0b6f 100644
--- a/README.md
+++ b/README.md
@@ -30,10 +30,23 @@ Optionally you can also add the following section to generate a usage guide, rep
 <!-- action-docs-usage source="action.yml" project="<project>" version="<version>" -->
 ```
 
-### Generate docs via CLI
+### Install
+
+#### npm
 
 ```bash
 npm install -g action-docs
+```
+
+#### brew
+
+```bash
+brew install action-docs
+```
+
+### Generate docs via CLI
+
+```bash
 cd <your github action>
 
 # write docs to console