Add "pdfman" plugin

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index 940fc19f8c3f6d45eb5f4678c18d62d17b525e89..965733ddd88d017b3dcb924d09d719fe095f8308 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,54 @@
 AX-ZSH: Alex' Modular ZSH Configuration
 =======================================
 
+AX-ZSH is a modular configuration system for the Z shell. If provides sane
+defaults and is extendable by plugins.
+
+
+Configuration
+-------------
+
+AX-ZSH can be configured using settings in a `$HOME/.zshenv` file.
+
+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
+   * correction
+   * grep
+   * history
+   * less
+   * ls
+   * prompt
+   * ssh
+   * std_aliases
+   * std_env
+   * std_options
+* `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
+axzsh_default_plugins=()
+
+# Add additional plugins
+axzsh_plugins=(
+       editor_select
+       homebrew
+)
+```
+
+Note: it should *not* be necessary to disable the default plugins! The above
+is an example only!
+
 
 Environment Variables
 ---------------------
@@ -10,7 +58,7 @@ Expected to be already set:
 * `HOME`
 * `LOGNAME`
 
-Validated and/or set up:
+Validated and/or set up by core plugins:
 
 * `AXZSH`
 * `HOST`
@@ -21,12 +69,3 @@ Validated and/or set up:
 * `TERM`
 * `XDG_CACHE_HOME`
 * `ZSH_CACHE_DIR`
-
-
-Configuration Variables
------------------------
-
-The following configuration variables can be set in the `$HOME/.zshenv` file
-to configure "AX-ZSH":
-
-* `AXZSH_PLUGIN_D`