pyenv: add README (#8224)

2019-10-07 10:53:18 -05:00 · 2019-10-07 10:53:18 -05:00 · d5e7040ebd
commit d5e7040ebd
parent e2d5426f42
1 changed files with 16 additions and 0 deletions
--- a/plugins/pyenv/README.md
+++ 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.