Add comment for "autoenv_debug: fix error with Zsh 5.0.5"

[zsh-autoenv.git] / README.md

diff --git a/README.md b/README.md
index 78578ccdea7ec2aff218c7b087c8e05db85ee4e5..9dfb58095d949bf12dea73b0a9b0a45d5852cd5a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -57,10 +57,16 @@ The varstash library has been taken from smartcd, and was optimized for Zsh.
 
 ### `autoenv_source_parent()`
 
-zsh-autoenv will stop looking for `.autoenv.zsh` files after the first one has
-been found.  But you can use the function `autoenv_source_parent` to source a
-parent `.autoenv.zsh` file from there.
+zsh-autoenv will stop looking for `.autoenv.zsh` files upwards after the first
+one has been found, but you can use the function `autoenv_source_parent` to
+source the next `.autoenv.zsh` file upwards the directory tree from there.
 
+The function accepts an optional argument, which allows to stop looking before
+the file system root is reached:
+
+```zsh
+autoenv_source_parent ../..
+```
 
 ## Installation
 
@@ -112,13 +118,14 @@ Default: `1`
 
 Default: 0
 
-### `AUTOENV_DEBUG`
+### AUTOENV\_DEBUG
 Enable debugging. Multiple levels are supported (max 2).
 
 Default: `0`
 
 
 ## Related projects
+- https://github.com/direnv/direnv
 - https://github.com/cxreg/smartcd
 - https://github.com/kennethreitz/autoenv