Update README.md

brightnetwork · Oct 1, 2024 · 54f89cf · 54f89cf
1 parent 1cc2e06
commit 54f89cf
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,30 @@ pip install iter-pipes
 
 ### Examples
 
+#### pipe:
+
+```python
+from collections.abc import Iterable
+
+from iter_pipes import PipelineFactory
+
+
+def process_a(items: Iterable[int]):
+    for item in items:
+        yield item * 2 + 1
+
+
+def process_b(items: Iterable[int]):
+    for item in items:
+        yield item
+        yield -item
+
+
+pipeline = PipelineFactory[int]().pipe(process_a).pipe(process_b)
+
+assert pipeline(range(3)).to_list() == [1, -1, 3, -3, 5, -5]
+```
+
 #### map / filter:
 
 ```python