From 6a43ee6523899aea27c25edd586307a9c1388171 Mon Sep 17 00:00:00 2001 From: Markus Bilz Date: Sat, 24 Feb 2024 14:34:53 +0500 Subject: [PATCH] docs: add instructions for installation via uv (#98) --- README.md | 9 ++++++++- docs/index.md | 9 ++++++++- pyproject.toml | 2 -- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e265bca..94f9ffd 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,15 @@ The key features are: * **Feature complete**: Wide range of supported algorithms. Use the algorithms individually or stack them like LEGO blocks. ## Installation + +**pip** +```console +pip install tclf +``` + +**[uv⚡](https://github.com/astral-sh/uv)** ```console -python -m pip install tclf +uv pip install tclf ``` ## Supported Algorithms diff --git a/docs/index.md b/docs/index.md index e265bca..94f9ffd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,8 +19,15 @@ The key features are: * **Feature complete**: Wide range of supported algorithms. Use the algorithms individually or stack them like LEGO blocks. ## Installation + +**pip** +```console +pip install tclf +``` + +**[uv⚡](https://github.com/astral-sh/uv)** ```console -python -m pip install tclf +uv pip install tclf ``` ## Supported Algorithms diff --git a/pyproject.toml b/pyproject.toml index 796dc36..5220de9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -78,10 +78,8 @@ name = "cz_conventional_commits" version = "0.3.0" tag_format = "$version" version_files = [ - "CITATION.cff:version = {", "docs/index.md:version", "pyproject.toml:version", - "README.md:version = {", "version", ] bump_message = "bump: version $current_version → $new_version"