Skip to content
Snippets Groups Projects
Commit 46e0b689 authored by nimrod's avatar nimrod
Browse files

- Some more documentation.

parent d0dd99c2
No related branches found
No related tags found
No related merge requests found
......@@ -4,8 +4,14 @@ Shell lint pre-commit hook
Shell lint `pre-commit <http://pre-commit.com/>`_ hook. The hook runs
:code:`/bin/sh -en` against found shell scripts.
Usage
-----
Dependencies
------------
- :code:`/bin/sh`
- Pre-commit
Installation
------------
Add the following to your :code:`.pre-commit-config.yaml`:
......@@ -16,6 +22,8 @@ Add the following to your :code:`.pre-commit-config.yaml`:
hooks:
- id: shell-lint
And run :code:`pre-commit autoupdate` to update the hooks.
License
-------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment