From 46e0b689bf2c58d3634eed45e8b6ae636d11b1df Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Wed, 16 Mar 2016 09:43:33 +0200
Subject: [PATCH] - Some more documentation.
---
README.rst | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.rst b/README.rst
index 742f1b2..37cbe6f 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
-------
--
GitLab