Merge branch 'master' of github.com:chewse/precommit-mirrors-pydocstyle

chewse · Mar 3, 2016 · cdbd632 · cdbd632
2 parents 73e0f62 + a984e3e
commit cdbd632
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+Pydocstyle mirror
+=============
+
+Mirror of the pydocstyle (formerly pep257) package for pre-commit.
+
+For pre-commit see: https://github.com/pre-commit/pre-commit
+
+For Pydocstyle see: https://github.com/PyCQA/pydocstyle
+
+
+### Using Pydocstyle with pre-commit
+
+Add this to your `.pre-commit-config.yaml`:
+
+    -   repo: git://github.com/chewse/pre-commit-mirrors-pydocstyle
+        sha: ''  # Use the sha / tag you want to point at
+        hooks:
+        -   id: pydocstyle