50_prompt: Show "logname" for root user by default

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index 8375e58a7c68bb56703c5d846b6bc918edb4ec54..c0317ae593cde64af818bd8426e4c8da7947b033 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,28 @@
 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.
+AX-ZSH is a modular configuration system for the Z shell (ZSH).
+If provides sane defaults and is extendable by plugins.
 
 
 Installation
 ------------
 
-To install AX-ZSH, call the `install.sh` script inside of the source directory.
-This script creates the `~/.axzsh` symbolic link to the source directory and
-creates links for `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, and `~/.zlogout`
-(don't worry, already existing files are backed up).
+To install AX-ZSH, either download a source archive or use Git to clone it.
+Afterwards use the `install.sh` script inside of the source directory to set
+up the `~/.axzsh` directory.
+
+When using Git it is best to directly clone the AX-ZSH repository into the
+`~/.axzsh` directory and call `install.sh` from this location:
+
+  $ git clone git://arthur.barton.de/ax-zsh.git ~/.axzsh
+  $ ~/.axzsh/install.sh
+
+You can use `cd ~/.axzsh && git pull --ff-only` to upgrade this installation.
+
+The `install.sh` script creates symbolic links for `~/.zprofile`, `~/.zshrc`,
+`~/.zlogin`, and `~/.zlogout` (don't worry, already existing files are backed
+up).
 
 Then you have to restart your ZSH session.
 
@@ -29,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
 ---------------------