Skip to content

Commit

Permalink
docs: update README to include pre-commit compatibility
Browse files Browse the repository at this point in the history
Since we have official support for pre-commit.com now, the README
indicates how to get this included in compatible projects.

Signed-off-by: Joey Espinosa <jlouis.espinosa@gmail.com>
  • Loading branch information
particledecay authored and andrewrynhard committed Feb 25, 2020
1 parent ea7199a commit a55d411
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,19 @@ EOF
chmod +x .git/hooks/commit-msg
```

We also provide a [Pre-Commit](https://pre-commit.com) hook that you can use as follows:

```yaml
# .pre-commit-config.yaml
repos:
- repo: https://github.com/talos-systems/conform
rev: master
hooks:
- id: conform
stages:
- commit-msg
```
### License
[![license](https://img.shields.io/github/license/talos-systems/conform.svg?style=flat-square)](https://github.com/talos-systems/conform/blob/master/LICENSE)

0 comments on commit a55d411

Please sign in to comment.