summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/autoenv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/autoenv/README.md')
-rw-r--r--oh-my-zsh/plugins/autoenv/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/autoenv/README.md b/oh-my-zsh/plugins/autoenv/README.md
new file mode 100644
index 0000000..5dfb5fb
--- /dev/null
+++ b/oh-my-zsh/plugins/autoenv/README.md
@@ -0,0 +1,20 @@
+# Autoenv plugin
+
+This plugin loads the [Autoenv](https://github.com/inishchith/autoenv).
+
+To use it, add `autoenv` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... autoenv)
+```
+
+## Functions
+
+* `use_env()`: creates and/or activates a virtualenv. For use in `.env` files.
+ See the source code for details.
+
+## Requirements
+
+In order to make this work, you will need to have the autoenv installed.
+
+More info on the usage and install at [the project's homepage](https://github.com/inishchith/autoenv).