diff --git a/README.rst b/README.rst index 742f1b219dab8f6019b340fe8ddc335ae43552f2..37cbe6ff44b611d3ba0238a94449efa3e40e4163 100644 --- a/README.rst +++ b/README.rst @@ -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 -------