96f4a938383e558e8f800ccc052a80c6f743555d

Author
Sagar Patil <sagar010797@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

virtualenv: add README (#7273)

Diff

 1diff --git a/plugins/virtualenv/README.md b/plugins/virtualenv/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..e0b8c2c8203efafbf340c222bb95530e1230af45
 4--- /dev/null
 5+++ b/plugins/virtualenv/README.md
 6@@ -0,0 +1,15 @@
 7+# virtualenv
 8+
 9+The plugin displays information of the created virtual container and allows background theming.
10+
11+To use it, add `virtualenv` to the plugins array of your zshrc file:
12+```
13+plugins=(... virtualenv)
14+```
15+
16+The plugin creates a `virtualenv_prompt_info` function that you can use in your theme, which displays
17+the basename of the current `$VIRTUAL_ENV`. It uses two variables to control how that is shown:
18+
19+- `ZSH_THEME_VIRTUALENV_PREFIX`: sets the prefix of the VIRTUAL_ENV. Defaults to `[`.
20+
21+- `ZSH_THEME_VIRTUALENV_SUFFIX`: sets the suffix of the VIRTUAL_ENV. Defaults to `]`.