Add README.md files for plugins

diff --git a/plugins/ccache/README.md b/plugins/ccache/README.md
new file mode 100644 (file)
index 0000000..2880d28
--- /dev/null
+++ b/plugins/ccache/README.md
@@ -0,0 +1,10 @@
+## ccache
+
+Setup *ccache(1)*, "a fast C/C++ compiler cache":
+
+1. Configure the cache directory to `$XDG_CACHE_HOME/ccache`,
+2. Search for *ccache* wrapper scripts and setup `$PATH`.
+
+### Environment
+
+- `$PATH`: Prepend include directory containing *ccache* wrapper scripts.

diff --git a/plugins/docker-machine/README.md b/plugins/docker-machine/README.md
new file mode 100644 (file)
index 0000000..dc9db4e
--- /dev/null
+++ b/plugins/docker-machine/README.md
@@ -0,0 +1,4 @@
+## docker-machine
+
+Setup the environment for the "local-default" configuration of
+*docker-machine*(1).

diff --git a/plugins/editor_select/README.md b/plugins/editor_select/README.md
new file mode 100644 (file)
index 0000000..55af6cb
--- /dev/null
+++ b/plugins/editor_select/README.md
@@ -0,0 +1,22 @@
+## editor_select
+
+Search for the "best" editor and setup environment (`$EDITOR`) accordingly.
+
+The plugin looks for the following editors and stops at the first one it finds:
+
+- atom
+- mate
+- subl
+- vim
+- nano
+- joe
+- vi
+
+### Command Aliases
+
+- `zshenv`: Edit `~/.zshenv` using `$EDITOR`
+  (only available if an editor was found).
+
+### Environment
+
+- `$EDITOR`: Command (including parameters) to run an text editor.

diff --git a/plugins/fzf/README.md b/plugins/fzf/README.md
new file mode 100644 (file)
index 0000000..12c8252
--- /dev/null
+++ b/plugins/fzf/README.md
@@ -0,0 +1,20 @@
+## fzf
+
+Integrate *fzf*, "a command-line fuzzy finder", into ZSH.
+
+### Usage
+
+This plugin uses the ZSH configuration files of *fzf*(1) itself to enable
+*fzf* functionality in ZSH;
+at the time of this writing, September 26 2015 using *fzf* 0.10.5, this is
+
+1. Fuzzy completion for in the command line, triggered by `**`+`<TAB>`, see
+   https://github.com/junegunn/fzf#fuzzy-completion-for-bash-and-zsh for
+   details.
+2. Add Keybindings.
+
+### Key Bindings
+
+- `CTRL-T`: Paste the selected file path(s) into the command line.
+- `ALT-C`: `cd` into the selected directory.
+- `CTRL-R`: Paste the selected command from history into the command line.

diff --git a/plugins/git/README.md b/plugins/git/README.md
new file mode 100644 (file)
index 0000000..d9343eb
--- /dev/null
+++ b/plugins/git/README.md
@@ -0,0 +1,14 @@
+## git
+
+Enable ZSH *Git* integration:
+
+1. Enhance shell prompt inside *Git* trees.
+2. Define some aliases.
+
+### Command Aliases
+
+- `ga`: `git add`
+- `gc`: `git commit`
+- `gd`: `git diff`
+- `gdc`: `git diff --cached`
+- `gst`: `git status --short --branch --untracked`

diff --git a/plugins/gnupg/README.md b/plugins/gnupg/README.md
new file mode 100644 (file)
index 0000000..8ed3ae6
--- /dev/null
+++ b/plugins/gnupg/README.md
@@ -0,0 +1,10 @@
+## gnupg
+
+Setup *GnuPG* using *gpg*(1) or *gpg2*(1) command:
+
+- `gpg2`: use the same completions than for `gpg`.
+- When `gpg` isn't installed but `gpg2` is, alias it to `gpg`, too.
+
+### Command Aliases
+
+- `gpg`: When `gpg2` is available but `gpg` isn't.

diff --git a/plugins/homebrew/README.md b/plugins/homebrew/README.md
new file mode 100644 (file)
index 0000000..201b8dd
--- /dev/null
+++ b/plugins/homebrew/README.md
@@ -0,0 +1,5 @@
+## homebrew
+
+Setup "Homebrew" ("The missing package manager for OS X", http://brew.sh):
+
+- Enable ZSH completions installed by Homebrew formulae.

diff --git a/plugins/hub/README.md b/plugins/hub/README.md
new file mode 100644 (file)
index 0000000..d581476
--- /dev/null
+++ b/plugins/hub/README.md
@@ -0,0 +1,7 @@
+## hub
+
+Setup *hub*(1), a wrapper script integrating GitHub related functions in Git.
+
+### Command Aliases
+
+- `git`: `hub` (enable the wrapper script)

diff --git a/plugins/keychain/README.md b/plugins/keychain/README.md
new file mode 100644 (file)
index 0000000..808d4c6
--- /dev/null
+++ b/plugins/keychain/README.md
@@ -0,0 +1,6 @@
+## keychain
+
+Initialize *keychain*(1), "re-use ssh-agent and/or gpg-agent between logins".
+
+Check which agents are available (`ssh-agent` and/or `gpg-agent`), and call
+`keychain` accordingly.

diff --git a/plugins/mosh/README.md b/plugins/mosh/README.md
new file mode 100644 (file)
index 0000000..e0bd8b5
--- /dev/null
+++ b/plugins/mosh/README.md
@@ -0,0 +1,5 @@
+## mosh
+
+Setup *mosh*(1), the "mobile shell with roaming and intelligent local echo":
+
+- Enable `ssh` completions for `mosh`.

diff --git a/plugins/pdfman/README.md b/plugins/pdfman/README.md
new file mode 100644 (file)
index 0000000..7a83294
--- /dev/null
+++ b/plugins/pdfman/README.md
@@ -0,0 +1,5 @@
+## pdfman
+
+### Command Aliases
+
+- `man`: `pdfman` (when `pdfman` is available).

diff --git a/plugins/ssh_secure/README.md b/plugins/ssh_secure/README.md
new file mode 100644 (file)
index 0000000..8d6876c
--- /dev/null
+++ b/plugins/ssh_secure/README.md
@@ -0,0 +1,34 @@
+## ssh_secure
+
+Make `ssh`(1) more secure by adding command aliases.
+
+### Usage
+
+Make sure to enable *"strict hostkey checking"* for `ssh`, add something like
+the following to you `~/.ssh/config` file to make `ssh` more secure by default:
+
+    # Trusted test network with changing hosts
+    Host *.example.net
+        StrictHostKeyChecking no
+        UserKnownHostsFile /dev/null
+
+    # Be more secure by default!
+    Host *
+        CheckHostIP yes
+        StrictHostKeyChecking yes
+
+Now you can use the following commands (see aliases below):
+
+- `ssh`: establish a new SSH connection to *known* hosts.
+- `sshtmp`: establish a *temporary* SSH connection to an *unknown* host.
+- `sshnew`: establish a SSH connection to an *unknown* host and add it to
+  the "known hosts" list.
+
+
+### Command Aliases
+
+- `sshnew`: Don't use "strict host key checking", which allows adding new and
+  unknown hosts.
+- `sshtmp`: Don't use "strict host key checking" and don't use the "known
+  hosts" list at all, which allows to temporarily `ssh` to an unknown host
+  without the need to alter the *UserKnownHostsFile* at all.

diff --git a/plugins/thefuck/README.md b/plugins/thefuck/README.md
new file mode 100644 (file)
index 0000000..8affb4b
--- /dev/null
+++ b/plugins/thefuck/README.md
@@ -0,0 +1,7 @@
+## thefuck
+
+Setup thefuck(1) to "programmatically correct mistyped console commands".
+
+### Command Aliases
+
+- `fuck`

diff --git a/plugins/virtualenvwrapper/README.md b/plugins/virtualenvwrapper/README.md
new file mode 100644 (file)
index 0000000..66012d6
--- /dev/null
+++ b/plugins/virtualenvwrapper/README.md
@@ -0,0 +1,9 @@
+## virtualenvwrapper
+
+Look for and setup the Python *virtualenvwrapper*.
+
+### Environment
+
+- `$PIP_REQUIRE_VIRTUALENV`
+- `$PROJECT_HOME`
+- `$WORKON_HOME`

diff --git a/plugins/zkbd/README.md b/plugins/zkbd/README.md
new file mode 100644 (file)
index 0000000..12bf24e
--- /dev/null
+++ b/plugins/zkbd/README.md
@@ -0,0 +1,3 @@
+## zkbd
+
+Initialize ZSH standard keybindings using its *zkbd* module.

diff --git a/plugins/zsh-syntax-highlighting/README.md b/plugins/zsh-syntax-highlighting/README.md
new file mode 100644 (file)
index 0000000..1494ba6
--- /dev/null
+++ b/plugins/zsh-syntax-highlighting/README.md
@@ -0,0 +1,4 @@
+## zsh-syntax-highlighting
+
+Initialize "ZSH Syntax Highlighting", see
+https://github.com/zsh-users/zsh-syntax-highlighting.