diff --git a/README.rst b/README.rst index a68d671a824ee921175634865db85de644834155..1318bf83b1a1fb3e9bfd54efdba3863524f29171 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 -------