Skip to content

Commit

Permalink
docs: update main documentation (to add new hooks/features)
Browse files Browse the repository at this point in the history
  • Loading branch information
doniz committed Mar 21, 2024
1 parent 90fe0e4 commit fd3f8c4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ remotes:
- hooks/shellcheck/.lefthook.yaml
# check if the license headers are present in the files
- hooks/license-checker/.lefthook.yaml
# lint the markdown (.md) files
- hooks/markdown-lint/.lefthook.yaml
# A linter for YAML files.
- hooks/yamllint/.lefthook.yaml
# validate the JSON files
- hooks/jsonlint/.lefthook.yaml
```
Run `lefthook install` (follow the [installation guide](https://github.com/evilmartians/lefthook/blob/master/docs/install.md)
Expand All @@ -55,6 +61,10 @@ for shell scripts
- [license-checker](./hooks/license-checker/) (**pre-commit**) - Checks if the
license headers are present in the Git staged files with possibility to exclude
certain files or file extensions using Regular Expression pattern.
- [jsonlint](./hooks/jsonlint/) (**pre-commit**) - Validation tool for JSON files.
- [yamllint](./hooks/yamllint/) (**pre-commit**) - A linter for YAML files.
- [markdown-lint](./hooks/markdown-lint/) (**pre-commit**) - is a static
analysis tool for *.md files.

## About Boozt

Expand Down

0 comments on commit fd3f8c4

Please sign in to comment.