Skip to content

Commit 5648939

Browse files
committed
update docs for 'uv'
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
1 parent 1bacca9 commit 5648939

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/usage.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,23 @@
33
## Installation
44

55
Clone [this repository][repo]{:target="_blank"} and install the
6-
dependencies. This project uses [Poetry][poetry]{:target="_blank"} for
6+
dependencies. This project uses [uv][uv]{:target="_blank"} for
77
dependency management which should be installed on your system first.
88

99
Install the dependencies:
1010

1111
```console
12-
poetry install
12+
uv sync
1313
```
1414

1515
Then switch to the virtual environment:
1616

1717
```console
18-
poetry shell
18+
# On Linux:
19+
source .venv/bin/activate
20+
21+
# On Windows:
22+
.venv\Scripts\activate
1923
```
2024

2125
## Usage
@@ -89,7 +93,7 @@ SQLite database.
8993
DATABASE_URL = "sqlite+aiosqlite:///./test.db"
9094
```
9195

92-
[poetry]: https://python-poetry.org/
96+
[uv]: https://docs.astral.sh/uv/
9397
[postgres]:https://www.postgresql.org/
9498
[docker]:https://www.docker.com/
9599
[sqlite]:https://www.sqlite.org/

0 commit comments

Comments
 (0)