d5e7040ebdfc9d9525b964c35ef1e704da632be2

Author
Joe Rattazzi <joerattazzi@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

pyenv: add README (#8224)

Diff

 1diff --git a/plugins/pyenv/README.md b/plugins/pyenv/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..d063b55b9b64572cd02f192008ce91934215d002
 4--- /dev/null
 5+++ b/plugins/pyenv/README.md
 6@@ -0,0 +1,16 @@
 7+# pyenv 
 8+
 9+This plugin looks for [pyenv](https://github.com/pyenv/pyenv), a Simple Python version
10+management system, and loads it if it's found. It also loads pyenv-virtualenv, a pyenv
11+plugin to manage virtualenv, if it's found.
12+
13+To use it, add `pyenv` to the plugins array in your zshrc file:
14+
15+```zsh
16+plugins=(... pyenv)
17+```
18+
19+## Functions
20+
21+- `pyenv_prompt_info`: displays the Python version in use by pyenv; or the global Python
22+  version, if pyenv wasn't found.