Add README example

maddiesch · Feb 26, 2024 · f615f88 · f615f88
1 parent 025df89
commit f615f88
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,3 +7,21 @@
 [![License](https://img.shields.io/github/license/maddiesch/go-bus)](./LICENSE)
 
 A multi-producer multi-consumer generic event bus.
+
+```go
+eventBus := bus.New[string]()
+
+subscription, cancel := eventBus.Sink()
+defer cancel()
+
+go produceEvents(eventBus)
+
+for event := range subscription {
+  switch event {
+  case "stop":
+    return
+  default:
+    fmt.Println(event)
+  }
+}
+```
diff --git a/example_test.go b/example_test.go
@@ -19,3 +19,28 @@ func ExampleBus() {
 	fmt.Println(message)
 	// Output: Hello, World!
 }
+
+func ExampleBus_Sink() {
+	eventBus := bus.New[string]()
+
+	subscription, cancel := eventBus.Sink()
+	defer cancel()
+
+	go produceEvents(eventBus)
+
+	for event := range subscription {
+		switch event {
+		case "stop":
+			return
+		default:
+			fmt.Println(event)
+		}
+	}
+
+	// Output: Hello, World!
+}
+
+func produceEvents(eventBus *bus.Bus[string]) {
+	eventBus.Publish("Hello, World!")
+	eventBus.Publish("stop")
+}