Skip to content

Commit 54ae52a

Browse files
docs: lead install instructions with uv, pip as alternative
README and Quickstart now show ``uv add openarmature`` first, with ``pip install openarmature`` as the alternative line. Matches the project's "uv for everything" convention (per AGENTS.md) while keeping the pip path visible for readers who haven't moved to uv yet. README still keeps the ``uv add --editable /path/...`` pattern as the standalone "for editable local development" example.
1 parent 65dc890 commit 54ae52a

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ Python reference implementation of [OpenArmature](https://github.com/LunarComman
77
## Install
88

99
```bash
10-
pip install openarmature # core
11-
pip install 'openarmature[otel]' # with OpenTelemetry observability
10+
uv add openarmature # core
11+
uv add 'openarmature[otel]' # with OpenTelemetry observability
12+
# or, with pip:
13+
pip install openarmature
14+
pip install 'openarmature[otel]'
1215
```
1316

14-
Or for editable local development:
17+
For editable local development:
1518

1619
```bash
1720
uv add --editable /path/to/openarmature-python

docs/getting-started/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ shape on one screen.
77
## Install
88

99
```bash
10+
uv add openarmature
11+
# or, with pip:
1012
pip install openarmature
1113
```
1214

0 commit comments

Comments
 (0)