summaryrefslogtreecommitdiff
path: root/plugins/direnv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/direnv/README.md')
-rw-r--r--plugins/direnv/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/direnv/README.md b/plugins/direnv/README.md
new file mode 100644
index 000000000..8deaf38bb
--- /dev/null
+++ b/plugins/direnv/README.md
@@ -0,0 +1,15 @@
+# direnv plugin
+
+This plugin creates the [Direnv](https://direnv.net/) hook.
+
+To use it, add `direnv` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... direnv)
+```
+
+## Requirements
+
+In order to make this work, you will need to have the direnv installed.
+
+More info on the usage and install: https://github.com/direnv/direnv