From e81b51714494fc061b41881397c08ba4d5d8b7fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Fri, 16 Feb 2024 08:39:54 -0800 Subject: [PATCH] Fix description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Bernát Gábor --- README.md | 10 +++++++++- pyproject.toml | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75098e2..726296c 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,12 @@ [![check](https://github.com/tox-dev/tox-uv/actions/workflows/check.yml/badge.svg)](https://github.com/tox-dev/tox-uv/actions/workflows/check.yml) [![Downloads](https://static.pepy.tech/badge/tox-uv/month)](https://pepy.tech/project/tox-uv) -**tox-uv** is a tox plugin which replaces pip with uv in tox. +**tox-uv** is a tox plugin which replaces virtualenv and pip with uv your tox environments. +Note that you will get both the benefits (performance) or downsides (bugs) of uv. + +Simply install `tox-uv` into the environment your tox is installed and will replace virtualenv and pip in the tox +run environments with uv. + +Note: currently we haven't implemented uv support for packaging environments, so only your run tox environments will +use uv. Also, uv does not have at the moment a `pip freeze/list` like feature, so we still install pip into the +environment to perform this operation via pip. diff --git a/pyproject.toml b/pyproject.toml index c1994a5..db91dd1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ requires = [ [project] name = "tox-uv" -description = "Integration of uv into GitHub Actions." +description = "Integration of uv with tox." readme = "README.md" keywords = [ "environments",