Add publisher configuration example docs

ossf · Apr 15, 2021 · a331ce2 · a331ce2
1 parent 6a22d67
commit a331ce2
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/publisher/README.md b/publisher/README.md
@@ -0,0 +1,33 @@
+# Publishers
+
+Various publishers are available for use publishing packages, each of these can be configured for use as seen in examples below.
+
+## Configuration examples
+
+### stdout
+
+```
+publisher:
+    type: stdout
+```
+
+### GCP Pub Sub
+
+```
+publisher:
+    type: gcp_pubsub
+    config:
+        url: gcppubsub://foo.bar
+```
+
+### stdout
+
+```
+publisher:
+    type: kafka
+    config:
+        brokers:
+            - 127.0.0.1:9092
+        topic: packagefeeds
+```
+