Skip to content

Commit 9de5063

Browse files
committed
Add quick start to readme
1 parent acad765 commit 9de5063

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@
3333

3434
</div>
3535

36+
## Quick Start
37+
38+
The **cev** package has a cli to quickly try out a demo of comparison widget in JupyterLab. It requires [uv](https://astral.sh/uv) to be installed.
39+
40+
```sh
41+
uvx --python 3.11 cev demo # Downloads datasets and launches Jupyter Lab
42+
```
43+
3644
## Installation
3745

3846
> **Warning**: `cev` is new and under active development. It is not yet ready for production and APIs are subject to change.

0 commit comments

Comments
 (0)