From 96f4a938383e558e8f800ccc052a80c6f743555d Mon Sep 17 00:00:00 2001
From: Sagar Patil <sagar010797@gmail.com>
Date: Sat, 13 Oct 2018 01:24:26 +0530
Subject: [PATCH] virtualenv: add README (#7273)

---
 plugins/virtualenv/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 plugins/virtualenv/README.md

diff --git a/plugins/virtualenv/README.md b/plugins/virtualenv/README.md
new file mode 100644
index 000000000..e0b8c2c82
--- /dev/null
+++ b/plugins/virtualenv/README.md
@@ -0,0 +1,15 @@
+# virtualenv
+
+The plugin displays information of the created virtual container and allows background theming.
+
+To use it, add `virtualenv` to the plugins array of your zshrc file:
+```
+plugins=(... virtualenv)
+```
+
+The plugin creates a `virtualenv_prompt_info` function that you can use in your theme, which displays
+the basename of the current `$VIRTUAL_ENV`. It uses two variables to control how that is shown:
+
+- `ZSH_THEME_VIRTUALENV_PREFIX`: sets the prefix of the VIRTUAL_ENV. Defaults to `[`.
+
+- `ZSH_THEME_VIRTUALENV_SUFFIX`: sets the suffix of the VIRTUAL_ENV. Defaults to `]`.