X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=README.md;h=e309db13b5e122b902a832ec6c35e39687d8008a;hb=eebdce22dfc7e987554510feee93dd5ecfbc268a;hp=0f88ba0ff17ee2fb3ba2a496e37498bed3b9478b;hpb=58268b8da3818476d6698ec044a64b25bad5a24e;p=zsh-autoenv.git diff --git a/README.md b/README.md index 0f88ba0..e309db1 100644 --- 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