Skip to content

Commit 8e52c33

Browse files
committed
docs(quickstart): align prerelease guidance with uv
1 parent 811dad8 commit 8e52c33

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

docs/quickstart.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,9 @@ For example, `0.27.0a1` is the first alpha release of `0.27.0` before general av
4141
- [uv]:
4242

4343
```console
44-
$ uv add --prerelease=allow unihan-etl
44+
$ uv add unihan-etl --prerelease allow
4545
```
4646

47-
```console
48-
$ uv add --prerelease=allow 'unihan-etl==0.27.0a1'
49-
```
50-
51-
The second command demonstrates pinning to a specific pre-release version.
52-
5347
- [pip]\:
5448

5549
```console
@@ -64,19 +58,19 @@ For example, `0.27.0a1` is the first alpha release of `0.27.0` before general av
6458

6559
Then run `unihan-etl@next load [session]`.
6660

67-
- `uvx`:
61+
- [uv tool install][uv-tools]:
6862

6963
```console
70-
$ uvx --prerelease=allow unihan-etl
64+
$ uv tool install --prerelease allow unihan-etl
7165
```
7266

67+
- [uvx][uvx]:
68+
7369
```console
74-
$ uvx --from 'unihan-etl==0.27.0a1' unihan-etl
70+
$ uvx --from 'unihan-etl' --prerelease allow unihan-etl
7571
```
7672

77-
The second command runs the pinned pre-release without installing it.
78-
79-
Then rerun with your desired arguments, e.g. `uvx --prerelease=allow unihan-etl load [session]`.
73+
Then rerun with your desired arguments, e.g. `uvx --prerelease allow unihan-etl load [session]`.
8074

8175
via trunk (can break easily):
8276

@@ -103,6 +97,8 @@ via trunk (can break easily):
10397
[pip]: https://pip.pypa.io/en/stable/
10498
[pipx]: https://pypa.github.io/pipx/docs/
10599
[uv]: https://docs.astral.sh/uv/
100+
[uv-tools]: https://docs.astral.sh/uv/concepts/tools/
101+
[uvx]: https://docs.astral.sh/uv/guides/tools/
106102

107103
## Commands
108104

0 commit comments

Comments
 (0)