Introduce $AXZSH/custom_plugins directory

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index 4c641a26e486b359461de7a30b8dc4001df945c6..9f992eb5f2bfe38c621fabda609af6f85b4b0ee2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,6 +40,23 @@ relays on). In addition, AX-ZSH reads the optional files `~/.zprofile.local`,
 core initialization files when present.
 
 
+Customization
+-------------
+
+Use the `axzshctl` tool to enable, disable, and reset plugins. AXZSH
+initializes an alias which points to the actual location in `~/.axzsh/bin/`.
+
+See `axzshctl --help` for details.
+
+You can link custom plugins stored in arbitrary directories using `axzshctl`
+by specifying the complete path name. Or you can place additional plugins into
+the `~/.axzsh/custom_plugins` folder which is searched by the `axzshctl` tool
+by default.
+
+In addition you can set the `AXZSH_PLUGIN_D` variable (and `ZSH_CUSTOM` like
+"OhMyZsh") to specify additional plugin search directories.
+
+
 Environment Variables
 ---------------------