Merge pull request #248 from python-openapi/feature/pre-commit-hook-doc-update

pre-commit hook doc update

Author: p1c2u

README.rst

@@ -20,7 +20,7 @@ OpenAPI Spec validator
 About
 #####
 
-OpenAPI Spec Validator is a Python library that validates OpenAPI Specs
+OpenAPI Spec Validator is a CLI, pre-commit hook and python package that validates OpenAPI Specs
 against the `OpenAPI 2.0 (aka Swagger)
 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>`__,
 `OpenAPI 3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md>`__
@@ -80,6 +80,19 @@ or more pythonic way:
 
 For more details, read about `CLI (Command Line Interface) <https://openapi-spec-validator.readthedocs.io/en/latest/cli.html>`__.
 
+pre-commit hook
+***************
+
+.. code-block:: yaml
+
+   repos:
+   -   repo: https://github.com/python-openapi/openapi-spec-validator
+       rev: 0.5.5 # The version to use or 'master' for latest
+       hooks:
+       -   id: openapi-spec-validator
+
+For more details, read about `pre-commit hook <https://openapi-spec-validator.readthedocs.io/en/latest/hook.html>`__.
+
 Python package
 **************
 

docs/index.rst

@@ -10,7 +10,7 @@ openapi-spec-validator
    hook
    contributing
 
-OpenAPI Spec Validator is a Python library that validates OpenAPI Specs
+OpenAPI Spec Validator is a CLI, pre-commit hook and python package that validates OpenAPI Specs
 against the `OpenAPI 2.0 (aka Swagger)
 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>`__,
 `OpenAPI 3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md>`__
@@ -71,6 +71,18 @@ Usage
 
       Read more about the :doc:`cli`.
 
+   .. md-tab-item:: pre-commit hook
+
+      .. code-block:: yaml
+
+         repos:
+         -   repo: https://github.com/python-openapi/openapi-spec-validator
+             rev: 0.5.5 # The version to use or 'master' for latest
+             hooks:
+             -   id: openapi-spec-validator
+      
+      Read more about the :doc:`hook`.
+
    .. md-tab-item:: Python package
 
       .. code-block:: python