Update README.md

1995parham-learning · Sep 6, 2024 · ab28060 · ab28060
1 parent 4042ee6
commit ab28060
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
 <h1 align="center">In-memory central messaging queue for dummies</h1>
+
+## Introduction
+
+Sometimes you want to test your code with mocks and here is a mock for messaging queue. It tries to mimic the NATS concepts
+and for sure it cannot. It doesn't have any dependencies except Go standard libraries and you can easily use it in your tests.
+
+```go
+mmq := cmq.NewMockMessageQueue[int]()
+
+# register two different subscribing groups.
+mmq.Register("s1", "numbers", 10)
+mmq.Register("s2", "numbers", 10)
+```