docs: add instructions for installation via uv (#98)

KarelZe · Feb 24, 2024 · 6a43ee6 · 6a43ee6
1 parent 4a97281
commit 6a43ee6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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"