From 1f1d235a69c84e06eacc69b9a6041b79ddc51c2d Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Thu, 20 Mar 2025 13:36:24 +0100
Subject: Add basic README

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c268928..33b51b2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
 # Rivulet
 
-Elegant asynchronous data streams
\ No newline at end of file
+Elegant asynchronous data streams
+
+```python
+from rivulet import BatchProcessor
+
+async def item_stream():
+    for i in range(10):
+        yield i
+        await asyncio.sleep(0.1)
+
+async def main():
+    processor = BatchProcessor(batch_size=3, timeout_seconds=0.5)
+    
+    async for batch in processor.process(item_stream()):
+        print(f"Processing batch of {len(batch)} items: {batch}")
+```
\ No newline at end of file
-- 
cgit v1.3.1