From 7020043d144f1a936af16f4f8133703691e00be1 Mon Sep 17 00:00:00 2001 From: Adar Nimrod <nimrod@shore.co.il> Date: Wed, 16 Mar 2016 09:41:45 +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 a68d671..1318bf8 100644 --- a/README.rst +++ b/README.rst @@ -4,8 +4,14 @@ Ansible pre-commit hook Ansible `pre-commit <http://pre-commit.com/>`_ hook. The hook runs :code:`ansible --syntax-check` against playbooks declared. -Usage ------ +Dependencies +------------ + +- Ansible. +- Pre-commit. + +Installation +------------ Add the following to your :code:`.pre-commit-config.yaml`: @@ -17,6 +23,8 @@ Add the following to your :code:`.pre-commit-config.yaml`: - id: ansible-pre-commit files: playbook.yml +And run :code:`pre-commit autoupdate` to update the hooks. + License ------- -- GitLab