docs: Add formula notes for posterity

oslokommune · Nov 16, 2023 · 7eb3e70 · 7eb3e70
1 parent f0c8c43
commit 7eb3e70
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/Formula/README.md b/Formula/README.md
@@ -0,0 +1,21 @@
+# Homebrew formula
+
+The formula is generated by GoReleaser (see [`.goreleaser.yml`](../.goreleaser.yml)).
+
+The [private download strategy is from this Gist](https://gist.github.com/ZPascal/b21c652b811872b3f56db9d54d61d6c6?permalink_comment_id=4105298#gistcomment-4105298).
+
+## How it works
+
+When you run:
+
+```sh
+brew tap oslokommune/ok [email protected]:oslokommune/ok.git`
+```
+
+This directory is placed in `$(brew --repo)/Library/Taps/oslokommune/homebrew-ok`.
+
+To update it:
+
+```sh
+brew update
+```