README.rst

Documentation pre-commit hooks
##############################

.. image:: https://travis-ci.org/adarnimrod/docs-pre-commit.svg?branch=master
    :target: https://travis-ci.org/adarnimrod/docs-pre-commit

Documentation `pre-commit <http://pre-commit.com/>`_ hooks.

Installation
------------

Add the following to your :code:`.pre-commit-config.yaml`:

.. code:: yaml

    - repo: https://git.shore.co.il/nimrod/docs-pre-commit.git

License
-------

This software is licensed under the MIT license (see the :code:`LICENSE.txt`
file).

Author Information
------------------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
at: https://git.shore.co.il/nimrod/.