summaryrefslogtreecommitdiff
path: root/plugins/autoenv/README.md
diff options
context:
space:
mode:
authorAndrew Janke <andrew@apjanke.net>2015-12-18 18:45:17 -0500
committerMarc Cornellà <marc.cornella@live.com>2020-03-12 16:48:31 +0100
commit58e38155fc4342be1721f0b7b30f1e112fe38e93 (patch)
tree5bbee51b6766a64d416314f314fc95fa82eaba19 /plugins/autoenv/README.md
parent610b2529d2213a70e3d1153a9baf046c22f298b9 (diff)
downloadzsh-58e38155fc4342be1721f0b7b30f1e112fe38e93.tar.gz
zsh-58e38155fc4342be1721f0b7b30f1e112fe38e93.tar.bz2
zsh-58e38155fc4342be1721f0b7b30f1e112fe38e93.zip
autoenv: look in additional installation locations, redo logic
Fixes #4681 Co-authored-by: Marc Cornellà <marc.cornella@live.com>
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).