README.md: Update and enhance configuration section

Add an example for a ~/.zshenv file.

diff --git a/README.md b/README.md
index 940fc19f8c3f6d45eb5f4678c18d62d17b525e89..6e3c05ac62347bbfa944bfdb7e04f55fe49a6109 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Expected to be already set:
 * `HOME`
 * `LOGNAME`
 
-Validated and/or set up:
+Validated and/or set up by core plugins:
 
 * `AXZSH`
 * `HOST`
@@ -23,10 +23,46 @@ Validated and/or set up:
 * `ZSH_CACHE_DIR`
 
 
-Configuration Variables
------------------------
+Configuration
+-------------
 
-The following configuration variables can be set in the `$HOME/.zshenv` file
-to configure "AX-ZSH":
+AX-ZSH can be configured using settings in a `$HOME/.zshenv` file.
 
-* `AXZSH_PLUGIN_D`
+The following configuration variables are supported:
+
+* `AXZSH_PLUGIN_D`: Optional directory for additional plugins.
+* `axzsh_default_plugins`: Array of default plugins, that will be loaded in
+  addition to the core plugins. You can reset this array to disable(!) loading
+  of these default plugins. Currently these plugins are loaded by default:
+   * byebye
+   * completion
+   * correction
+   * history
+   * ls
+   * prompt
+   * ssh
+   * std_aliases
+   * std_env
+* `axzsh_plugins`: Optional array of addiutional (non-core and non-default)
+  plugins to load.
+
+Example for a `$HOME/.zshenv` file:
+
+```
+# Add additinal custom plugin search path
+export AXZSH_PLUGIN_D="/opt/ax-zsh-plugins"
+
+# Disable all default plugins
+typedef -U axzsh_default_plugins
+axzsh_default_plugins=()
+
+# Add additional plugins
+typedef -U axzsh_plugins
+axzsh_plugins=(
+       editor_select
+       homebrew
+)
+```
+
+Note: it should *not* be necessary to disable the default plugins! The above
+is an example only!