summaryrefslogtreecommitdiff
path: root/plugins/paver/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/paver/README.md')
-rw-r--r--plugins/paver/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/plugins/paver/README.md b/plugins/paver/README.md
new file mode 100644
index 000000000..c38d898ba
--- /dev/null
+++ b/plugins/paver/README.md
@@ -0,0 +1,12 @@
+# Paver
+
+This plugin adds completion for the `paver` command-line tool of [Paver](https://pythonhosted.org/Paver/).
+
+To use it, add `paver` to the plugins array of your zshrc file:
+```zsh
+plugins=(... paver)
+```
+
+The completion function creates a cache of paver tasks with the name `.paver_tasks`,
+in the current working directory. It regenerates that cache when the `pavement.py`
+changes.