From 6a4000dad0d057ac35990ae604a219f88993ed2c Mon Sep 17 00:00:00 2001 From: "D. Bohdan" Date: Thu, 14 Nov 2024 21:24:38 +0000 Subject: [PATCH] docs(readme): add installation instructions for uv --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 78305e8..1289e64 100644 --- a/README.md +++ b/README.md @@ -105,34 +105,36 @@ Earlier versions of Python 3 will not work. The recommended way to run Remarshal is to install the latest release [from PyPI](https://pypi.org/project/remarshal/) with -[pipx](https://github.com/pypa/pipx). +[pipx](https://github.com/pypa/pipx) +or +[uv](https://github.com/astral-sh/uv). ```sh pipx install remarshal +# or +uv tool install remarshal ``` Regular installation is not mandatory. -The command - -```sh -pipx run remarshal [arg ...] -``` - -will download Remarshal and run it from a temporary location. +The command `pipx run remarshal [arg ...]` will download Remarshal and run it from a temporary location. It will cache the downloaded version for up to 14 days. Remarshal will not be automatically upgraded during this period. +You can use `uvx remarshal [arg ...]` the same way. -You can also install Remarshal using pip. +You can install Remarshal for the user with pip, +although it isn't recommended because of potential dependency version conflicts. ```sh python3 -m pip install --user remarshal ``` -It is possible to install the current development version of Remarshal. -Prefer releases unless you have a reason to run the development version. +It is also possible to install the current development version of Remarshal. +Prefer releases unless you have a reason to run a development version. ```sh pipx install git+https://github.com/remarshal-project/remarshal +# or +uv tool install https://github.com/remarshal-project/remarshal ``` ## Usage