Add "pdfman" plugin

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index 6e3c05ac62347bbfa944bfdb7e04f55fe49a6109..965733ddd88d017b3dcb924d09d719fe095f8308 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,8 @@
 AX-ZSH: Alex' Modular ZSH Configuration
 =======================================
 
-
-Environment Variables
----------------------
-
-Expected to be already set:
-
-* `HOME`
-* `LOGNAME`
-
-Validated and/or set up by core plugins:
-
-* `AXZSH`
-* `HOST`
-* `HOSTNAME` (same as HOST, deprecated)
-* `LOCAL_HOME`
-* `PS1`
-* `SHORT_HOST`
-* `TERM`
-* `XDG_CACHE_HOME`
-* `ZSH_CACHE_DIR`
+AX-ZSH is a modular configuration system for the Z shell. If provides sane
+defaults and is extendable by plugins.
 
 
 Configuration
@@ -35,14 +17,16 @@ The following configuration variables are supported:
   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
+   * 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.
 
@@ -53,11 +37,9 @@ Example for a `$HOME/.zshenv` file:
 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
@@ -66,3 +48,24 @@ axzsh_plugins=(
 
 Note: it should *not* be necessary to disable the default plugins! The above
 is an example only!
+
+
+Environment Variables
+---------------------
+
+Expected to be already set:
+
+* `HOME`
+* `LOGNAME`
+
+Validated and/or set up by core plugins:
+
+* `AXZSH`
+* `HOST`
+* `HOSTNAME` (same as HOST, deprecated)
+* `LOCAL_HOME`
+* `PS1`
+* `SHORT_HOST`
+* `TERM`
+* `XDG_CACHE_HOME`
+* `ZSH_CACHE_DIR`