From 4db0c3a39c31c53c950a41fbf69fb4a49ba4652a Mon Sep 17 00:00:00 2001 From: Saima Yasmeen <57188570+saimayasmeen4@users.noreply.github.com> Date: Sat, 11 Apr 2026 08:32:41 +0500 Subject: [PATCH] Update README.md docs: small README improvements --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e92d4ba..c506ff6 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,12 @@ Oris is **framework-agnostic**: Anything you can invoke like `run(dict)` can use ## Installation -The simplest way to install Oris is via pip: +The simplest way to install Oris is using pip:: ```bash pip install oris-ai ``` - -Verify the CLI: - +Verify the CLI installation: ```bash oris --help ``` @@ -93,7 +91,7 @@ Each run produces a `RunTrace` with per-step latency, status, and flags. `Pipeli **CLI parity** `oris validate` and `oris run` use the same definitions as `Pipeline.from_yaml` in Python, with `--format pretty` and `--debug` for human-friendly output and stderr trace lines. -## Quick Start +## *Quick Start* Save as `pipeline.yaml`: @@ -207,7 +205,7 @@ Repeat for the other notebooks, or open them in your editor. ## Contributing -We welcome issues and pull requests. Start with [`CONTRIBUTING.md`](CONTRIBUTING.md) (branches, quality gates, tests). Report security issues per [`SECURITY.md`](SECURITY.md). Community expectations : [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). +We welcome issues and pull requests. Start with [`CONTRIBUTING.md`](CONTRIBUTING.md) (branches, quality gates, tests). Report security issues per [`SECURITY.md`](SECURITY.md). Community expectations: [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). ## License