docs: Add Homebrew instructions to README

oslokommune · Nov 15, 2023 · 615231e · 615231e
1 parent 95da368
commit 615231e
Showing 1 changed file with 25 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,25 @@
-# ok
+# ok
+
+## Homebrew
+
+> WHEN THIS REPOSITORY IS PUBLIC...
+
+A Homebrew formula is included at [`./Formula/ok.rb`](Formula/ok.rb).
+
+```sh
+brew tap oslokommune/ok https://github.com/oslokommune/ok
+brew install ok
+```
+
+If you watch the project (Watch → Custom → Releases) you can easily upgrade to the latest version when notified:
+
+```sh
+brew upgrade ok
+```
+
+To uninstall:
+
+```sh
+brew uninstall ok
+brew untap oslokommune/ok
+```