diff --git a/README.md b/README.md index e9b281d..1394cb7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ The Norminette pre-commit hook. +## Requirements + +- [Pre-commit](https://pre-commit.com/index.html) must be installed on the system or in the repository virtual environment. + ## Usage Create a `.pre-commit-config.yaml` file in the root of your repository. @@ -14,7 +18,9 @@ default_language_version: repos: - repo: https://github.com/vcwild/norminette-hook - rev: main + rev: v0.1.0 hooks: - id: norminette-hook ``` + +When executing `pre-commit run` or `pre-commit run norminette-hook`, the hook will be executed.