Add helper functions for $PATH manipulation (#90)

[zsh-autoenv.git] / README.md

diff --git a/README.md b/README.md
index c49e66fe78ec206ce330b65add38c57a9a9ec8d0..fe81fe643195e6e6f088ecb38a6ce9e56cf14d66 100644 (file)
--- a/README.md
+++ b/README.md
@@ -149,6 +149,24 @@ zsh-autoenv works automatically once installed.
 You can use ``autoenv-edit`` to edit the nearest/current autoenv files.
 It will use ``$AUTOENV_EDITOR``, ``$EDITOR``, or ``vim`` for editing.
 
+## Helper functions
+
+The following helper functions are available:
+
+### autoenv_append_path
+
+Appends path(s) to `$path` (`$PATH`), if they are not in there already.
+
+### autoenv_prepend_path
+
+Prepends path(s) to `$path` (`$PATH`), if they are not in there already.
+
+### autoenv_remove_path
+
+Removes path(s) from `$path` (`$PATH`).
+
+Returns 0 in case `$path` has changed, 1 otherwise.
+
 ## Recipes
 
 ### Automatically activate Python virtualenvs