diff --git a/README.md b/README.md index 49b0a65..47de00a 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,25 @@ A [pre-commit](https://pre-commit.com/) hook for [Ruff](https://github.com/charliermarsh/ruff). -Distributed as a standalone repository to enable installing ruff via prebuilt wheels from +Distributed as a standalone repository to enable installing Ruff via prebuilt wheels from [PyPI](https://pypi.org/project/ruff/). For pre-commit: see https://github.com/pre-commit/pre-commit -For ruff: see https://github.com/charliermarsh/ruff +For Ruff: see https://github.com/charliermarsh/ruff ### Using ruff with pre-commit Add this to your `.pre-commit-config.yaml`: ```yaml - - repo: https://github.com/charliermarsh/ruff-pre-commit - rev: '' # Use the sha / tag you want to point at - hooks: - - id: ruff +- repo: https://github.com/charliermarsh/ruff-pre-commit + # Ruff version. + rev: 'v0.0.191' + hooks: + - id: ruff + # Respect `exclude` and `extend-exclude` settings. + args: ["--force-exclude"] ``` ## License