From 9de5063e2cd62cda42ec3beac976ef5f931260f6 Mon Sep 17 00:00:00 2001 From: Trevor Manz Date: Thu, 17 Oct 2024 02:11:52 -0400 Subject: [PATCH] Add quick start to readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5edca6e..3fbf918 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,14 @@ +## Quick Start + +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. + +```sh +uvx --python 3.11 cev demo # Downloads datasets and launches Jupyter Lab +``` + ## Installation > **Warning**: `cev` is new and under active development. It is not yet ready for production and APIs are subject to change.