Update readme for install requirements

Author: zph

.config/README.md.template

@@ -28,6 +28,24 @@ In this context, a runbook is a mixture of markdown and executable code that con
 1. Plan that runbook for a specific run `runbook plan runbook-name.ipynb --embed file.json --parameters '{"arg": 1, "foo": "baz"}'
 1. Run the instance of a runbook with either `runbook run runbook-name.ipynb` or use VSCode to run it `code runbooks/run/runbook-name.ipynb`
 
+## Installation
+
+We recommend using [uv](https://docs.astral.sh/uv/) or [pipx](https://pypi.org/project/pipx/) for installing runbook as a cli tool.
+
+```sh
+uv tool install git+https://github.com/zph/runbook.git
+# or
+pipx install git+https://github.com/zph/runbook.git
+```
+
+Or pin to a version
+
+```sh
+uv tool install git+https://github.com/zph/runbook.git@v0.0.1
+
+pipx install git+https://github.com/zph/runbook.git@v0.0.1
+```
+
 ## CLI
 
 ```sh
@@ -73,9 +91,6 @@ long as executions run through `runbook run ...` command
 ## Deno / Typescript
 1. Parameter cells should use `let` declarations to allow for param overriding
     - This is required to correctly support executing the ts version of notebooks.
-1. Confirm/prompt functions always return false in notebooks due to lack of support
-    in deno kernel. We may invest in upstreaming a patch to support this as it has support
-    in python notebooks
 
 # Readme Changes
 

README.md

@@ -28,6 +28,24 @@ In this context, a runbook is a mixture of markdown and executable code that con
 1. Plan that runbook for a specific run `runbook plan runbook-name.ipynb --embed file.json --parameters '{"arg": 1, "foo": "baz"}'
 1. Run the instance of a runbook with either `runbook run runbook-name.ipynb` or use VSCode to run it `code runbooks/run/runbook-name.ipynb`
 
+## Installation
+
+We recommend using [uv](https://docs.astral.sh/uv/) or [pipx](https://pypi.org/project/pipx/) for installing runbook as a cli tool.
+
+```sh
+uv tool install git+https://github.com/zph/runbook.git
+# or
+pipx install git+https://github.com/zph/runbook.git
+```
+
+Or pin to a version
+
+```sh
+uv tool install git+https://github.com/zph/runbook.git@v0.0.1
+
+pipx install git+https://github.com/zph/runbook.git@v0.0.1
+```
+
 ## CLI
 
 ```sh
@@ -90,9 +108,6 @@ long as executions run through `runbook run ...` command
 ## Deno / Typescript
 1. Parameter cells should use `let` declarations to allow for param overriding
     - This is required to correctly support executing the ts version of notebooks.
-1. Confirm/prompt functions always return false in notebooks due to lack of support
-    in deno kernel. We may invest in upstreaming a patch to support this as it has support
-    in python notebooks
 
 # Readme Changes