Skip to content

Commit 56c57d3

Browse files
committed
docs(quickstart): Add uv installation methods for developmental releases
why: Align with vcspull's documentation pattern and provide modern installation options for users who prefer uv over pip. what: - Add uv installation examples with --prerelease allow for developmental releases - Add uv git+https:// syntax for trunk installation - Remove pipx/uvx/uv tool methods as libvcs is a library, not a CLI tool - Simplify documentation to focus on package management tools relevant to libraries - Test commands locally to verify syntax correctness refs: Consistent with vcspull's approach to documenting installation methods
1 parent 5e2fe3c commit 56c57d3

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/quickstart.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,22 @@ $ pip install --user --upgrade libvcs
2020

2121
### Developmental releases
2222

23-
New versions of libvcs are published to PyPI as alpha, beta, or release candidates. In their
24-
versions you will see notification like `a1`, `b1`, and `rc1`, respectively. `1.10.0b4` would mean
25-
the 4th beta release of `1.10.0` before general availability.
23+
New versions of libvcs are published to PyPI as alpha, beta, or release candidates.
24+
In their versions you will see notification like `a1`, `b1`, and `rc1`, respectively.
25+
`1.10.0b4` would mean the 4th beta release of `1.10.0` before general availability.
2626

2727
- [pip]\:
2828

2929
```console
3030
$ pip install --user --upgrade --pre libvcs
3131
```
3232

33+
- [uv]\:
34+
35+
```console
36+
$ uv add libvcs --prerelease allow
37+
```
38+
3339
via trunk (can break easily):
3440

3541
- [pip]\:
@@ -38,4 +44,11 @@ via trunk (can break easily):
3844
$ pip install --user -e git+https://github.com/vcs-python/libvcs.git#egg=libvcs
3945
```
4046

47+
- [uv]\:
48+
49+
```console
50+
$ uv add "git+https://github.com/vcs-python/libvcs.git"
51+
```
52+
4153
[pip]: https://pip.pypa.io/en/stable/
54+
[uv]: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)