summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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