summaryrefslogtreecommitdiff
path: root/plugins/pyenv
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/pyenv')
-rw-r--r--plugins/pyenv/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/pyenv/README.md b/plugins/pyenv/README.md
new file mode 100644
index 000000000..d063b55b9
--- /dev/null
+++ b/plugins/pyenv/README.md
@@ -0,0 +1,16 @@
+# pyenv
+
+This plugin looks for [pyenv](https://github.com/pyenv/pyenv), a Simple Python version
+management system, and loads it if it's found. It also loads pyenv-virtualenv, a pyenv
+plugin to manage virtualenv, if it's found.
+
+To use it, add `pyenv` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... pyenv)
+```
+
+## Functions
+
+- `pyenv_prompt_info`: displays the Python version in use by pyenv; or the global Python
+ version, if pyenv wasn't found.