Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vcwild committed Aug 9, 2022
1 parent 52aef6f commit 8e0693f
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

0 comments on commit 8e0693f

Please sign in to comment.