Commit 46e0b689 authored by nimrod's avatar nimrod
Browse files

- Some more documentation.

parent d0dd99c2

README.rst

+10 −2
Changes for README.rst: 10 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -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

-------