From a50f1664f3535f7692561b0c17d2f2de6eae5a98 Mon Sep 17 00:00:00 2001
From: Caleb Albers <7110138+CalebAlbers@users.noreply.github.com>
Date: Wed, 25 Jan 2023 14:14:57 -0800
Subject: [PATCH] Add homebrew install instructions

---
 README.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 977602c..cddcb95 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,21 @@
 # copywrite
 
 This repo provides utilities for managing copyright headers and license files
-in HashiCorp repos.
+across many repos at scale.
 
 You can use it to add or validate copyright headers on source code files, add a
 LICENSE file to a repo, report on what licenses repos are using, and more.
 
 ## Getting Started
 
-Copywrite is installable on Windows, Linux, and MacOS from the [releases](https://github.com/hashicorp/copywrite/releases) page.
+The easiest way to get started is to use Homebrew:
+
+```sh
+brew tap hashicorp/tap
+brew install hashicorp/tap/copywrite
+```
+
+Installers for Windows, Linux, and MacOS are also available on the [releases](https://github.com/hashicorp/copywrite/releases) page.
 
 ## CLI Usage
 
@@ -134,12 +141,12 @@ freely in later steps.
   - name: Setup Copywrite
     uses: hashicorp/setup-copywrite@main
 
-  ...
-
   - name: Check Header Compliance
     run: copywrite headers --plan
 ```
 
+:bulb: Running the copywrite command with the `--plan` flag will return a non-zero exit code if the repo is out of compliance.
+
 ## Development
 
 ### IDE Settings