Added pre-commit usage section. (#88)

* Added pre-commit usage section. * Update README.rst * Update README.rst Co-authored-by: fsouza <[email protected]> * readme: make pre-commit happy Co-authored-by: fsouza <[email protected]>
PyCQA · Aug 23, 2022 · 71b2d11 · 71b2d11
1 parent 7b7749d
commit 71b2d11
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -171,3 +171,18 @@ To prevent that, without having to exclude the entire file, you can add a
     from .endpoints import role, token, user, utils  # noqa
 
 That line will instruct ``autoflake`` to let that specific line as is.
+
+
+Using pre-commit_ hooks
+=======================
+
+Add the following to your `.pre-commit-config.yaml`
+
+.. code-block:: yaml
+
+    - repo: https://github.com/PyCQA/autoflake
+      rev: v1.4
+      hooks:
+        - id: autoflake
+
+.. _pre-commit: https://pre-commit.com