summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2025-03-22 08:35:56 +0100
committerYuval Adam <_@yuv.al>2025-03-22 08:40:00 +0100
commit46178a419cb7c65055cb2ae9533b52101f39b9a2 (patch)
treeb647dddf799a4a26e727d37f206637c674c11e1b /README.md
parenta4ec6d0aa7b9f43866fbb91326595972e732253a (diff)
Add objects in READMEHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9b9d744..830d51c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,13 @@
# Rivulet
-Lightweight asynchronous data streams.
+Lightweight building blocks for asynchronous data streams. Provides:
+
+- [x] **Pipeline**: An asynchronous processing chain that connects a data source to a series of transformation steps.
+- [x] **Batch**: Accumulates individual stream items into batches of size `N` or when a timeout is reached.
+- [ ] **RateLimit**: Controls the flow rate of items through the pipeline by enforcing maximum items per time period constraints.
+- [ ] **Parallel**: Executes arbitary steps concurrently across multiple items.
+- [ ] **Join**: Combines multiple data streams into a single unified output stream.
+- [ ] **Cache**: Stores previously processed results to shortcircuit pipeline steps.
## Installation