docs: adds brew instructions (#3692)

Signed-off-by: Adrian Cole <[email protected]>
openzipkin · Jan 15, 2024 · e3dec43 · e3dec43
1 parent 4fb41a6
commit e3dec43
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.github/workflows/docker_push.yml b/.github/workflows/docker_push.yml
@@ -5,7 +5,7 @@ name: docker_push
 # documentation-only.
 on:  # yamllint disable-line rule:truthy
   push:
-    tags:  # e.g. release-1.2.3
+    tags:  # e.g. docker-1.2.3
       - 'docker-[0-9]+.[0-9]+.[0-9]+**'
 
 jobs:

diff --git a/README.md b/README.md
@@ -66,6 +66,15 @@ Running via Docker:
 docker run -d -p 9411:9411 openzipkin/zipkin-slim
 ```
 
+Running via [Homebrew](https://formulae.brew.sh/formula/zipkin):
+```bash
+brew install zipkin
+# to run in foreground
+zipkin
+# to run in background
+brew services start zipkin
+```
+
 ## Core Library
 The [core library](zipkin/src/main/java/zipkin2) is used by both Zipkin instrumentation and the Zipkin server.