summaryrefslogtreecommitdiff
path: root/plugins/pep8/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/pep8/README.md')
-rw-r--r--plugins/pep8/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/plugins/pep8/README.md b/plugins/pep8/README.md
new file mode 100644
index 000000000..a9a4f1cd0
--- /dev/null
+++ b/plugins/pep8/README.md
@@ -0,0 +1,8 @@
+# pep8 plugin
+
+This plugin adds completion for [pep8](https://pep8.readthedocs.io/en/release-1.7.x/#), a tool to check your Python code against some of the style conventions in [PEP 8](http://www.python.org/dev/peps/pep-0008/).
+
+To use it, add pep8 to the plugins array of your zshrc file:
+```
+plugins=(... pep8)
+```