summaryrefslogtreecommitdiff
path: root/plugins/poetry/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/poetry/README.md')
-rw-r--r--plugins/poetry/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/poetry/README.md b/plugins/poetry/README.md
new file mode 100644
index 000000000..51780cbed
--- /dev/null
+++ b/plugins/poetry/README.md
@@ -0,0 +1,9 @@
+# Poetry Plugin
+
+This plugin automatically installs [Poetry](https://python-poetry.org/)'s completions for you, and keeps them up to date as your Poetry version changes.
+
+To use it, add `poetry` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... poetry)
+```