Skip to content

Commit cf86758

Browse files
committed
Update readme
1 parent 709880f commit cf86758

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

.config/README.md.template

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ In this context, a runbook is a mixture of markdown and executable code that con
2121
1. One to execute the book
2222
2. A second to validate and perform safety checks
2323

24+
## Workflow
25+
26+
1. Initialize a new folder project with `runbook init...`
27+
1. Create a new runbook with `runbook create -l deno runbook-name.ipynb`
28+
1. Plan that runbook for a specific run `runbook plan runbook-name.ipynb --embed file.json --parameters '{"arg": 1, "foo": "baz"}'
29+
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`
30+
2431
## CLI
2532

2633
```sh

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ In this context, a runbook is a mixture of markdown and executable code that con
2121
1. One to execute the book
2222
2. A second to validate and perform safety checks
2323

24+
## Workflow
25+
26+
1. Initialize a new folder project with `runbook init...`
27+
1. Create a new runbook with `runbook create -l deno runbook-name.ipynb`
28+
1. Plan that runbook for a specific run `runbook plan runbook-name.ipynb --embed file.json --parameters '{"arg": 1, "foo": "baz"}'
29+
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`
30+
2431
## CLI
2532

2633
```sh

0 commit comments

Comments
 (0)