summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2025-03-21 22:28:44 +0100
committerYuval Adam <_@yuv.al>2025-03-21 22:31:00 +0100
commit286391c8c237340429fbdd4d0a8f5fab796bdca4 (patch)
treefa2c7627f5261744091b01be21f3255ab80b37e6
parent75944205db76ce8d05b189bd339f5a215793cf42 (diff)
Update README
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 09eda95..9718618 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,16 @@
# Rivulet
-Lightweight asynchronous data streams
+Lightweight asynchronous data streams.
+
+## Installation
+
+Package is not currently published, use directly from source:
+
+```bash
+$ uv add git+https://github.com/yuvadm/rivulet.git
+```
+
+## Usage
```python
from rivulet import Pipeline, Batch