summaryrefslogtreecommitdiff
path: root/plugins/autoenv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/autoenv/README.md')
-rw-r--r--plugins/autoenv/README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/plugins/autoenv/README.md b/plugins/autoenv/README.md
index de3881774..5dfb5fbe8 100644
--- a/plugins/autoenv/README.md
+++ b/plugins/autoenv/README.md
@@ -7,8 +7,14 @@ 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: https://github.com/inishchith/autoenv
+More info on the usage and install at [the project's homepage](https://github.com/inishchith/autoenv).