Skip to content

Commit 3415c4d

Browse files
committed
Document GitHub release install
1 parent e531ef9 commit 3415c4d

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,25 @@ Out of scope for this first version:
4848

4949
## Install
5050

51-
Install from PyPI:
51+
Install the released wheel from GitHub:
5252

5353
```bash
54-
uv pip install "sim-plugin-icepak==0.1.0"
54+
uv pip install "https://github.com/svd-ai-lab/sim-plugin-icepak/releases/download/v0.1.0/sim_plugin_icepak-0.1.0-py3-none-any.whl"
5555
```
5656

57-
For source testing against the current main branch:
57+
For source testing against the release tag or current main branch:
58+
59+
```bash
60+
uv pip install "git+https://github.com/svd-ai-lab/sim-plugin-icepak.git@v0.1.0"
61+
```
5862

5963
```bash
6064
uv pip install "git+https://github.com/svd-ai-lab/sim-plugin-icepak.git@main"
6165
```
6266

67+
The repository includes a manual PyPI publish workflow for maintainers who have
68+
configured the required package-publishing secret.
69+
6370
After installation, sim-cli should auto-discover the driver and bundled skill:
6471

6572
```bash

0 commit comments

Comments
 (0)