aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 639d953..466aaff 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
# Analysis
A collection of one-off analyses on a variety of topics.
+
+## Usage
+
+Edit a notebook with
+
+```shell
+uvx marimo edit --sandbox --headless notebooks/notebook.py
+```
+
+Run a notebook as an app with
+
+```shell
+uvx marimo run --sandbox --headless notebooks/notebook.py
+```
+
+Convert a notebook to HTML with
+
+```shell
+uvx marimo export html notebooks/notebook.py -o outputs/notebook.html --sandbox --no-include-code
+```