Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add instructions for installation via uv⚡ #98

Merged
merged 1 commit into from
Feb 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 8 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading