Clean up plugin READMEs and a few plugins

- fasd
- history
- mercurial
- pylint
- repo
- yii2

plugins/fasd/fasd.plugin.zsh

-if [ $commands[fasd] ]; then # check if fasd is installed
-  fasd_cache="${ZSH_CACHE_DIR}/fasd-init-cache"
-  if [ "$(command -v fasd)" -nt "$fasd_cache" -o ! -s "$fasd_cache" ]; then
-    fasd --init posix-alias zsh-hook zsh-ccomp zsh-ccomp-install \
-      zsh-wcomp zsh-wcomp-install >| "$fasd_cache"
-  fi
-  source "$fasd_cache"
-  unset fasd_cache
+# check if fasd is installed
+if (( ! ${+commands[fasd]} )); then
+  return
+fi
 
-  alias v='f -e "$EDITOR"'
-  alias o='a -e xdg-open'
-  alias j='zz'
+fasd_cache="${ZSH_CACHE_DIR}/fasd-init-cache"
+if [[ "$commands[fasd]" -nt "$fasd_cache" || ! -s "$fasd_cache" ]]; then
+  fasd --init posix-alias zsh-hook zsh-ccomp zsh-ccomp-install \
+    zsh-wcomp zsh-wcomp-install >| "$fasd_cache"
 fi
+source "$fasd_cache"
+unset fasd_cache
+
+alias v='f -e "$EDITOR"'
+alias o='a -e xdg-open'
+alias j='zz'

plugins/fbterm/README.md

@@ -3,7 +3,8 @@
 This plugin automatically starts [fbterm](https://github.com/zhangyuanwei/fbterm)
 if on a real TTY (`/dev/tty*`).
 
-To use it, add fbterm to the plugins array of your zshrc file:
-```
+To use it, add `fbterm` to the plugins array of your zshrc file:
+
+```zsh
 plugins=(... fbterm)
 ```

plugins/forklift/README.md

-## forklift
+# forklift
 
 Plugin for ForkLift, an FTP application for OS X.
 
-### Requirements
+To use it, add `forklift` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... forklift)
+```
+
+## Requirements
 
 * [ForkLift](https://binarynights.com/)
 
-### Usage
+## Usage
 
-<code>fl [*file_or_folder*]</code>
+`fl [<file_or_folder>]`
 
 * If `fl` is called without arguments then the current folder is opened in ForkLift. This is equivalent to `fl .`.
 
-* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift. If called with a non-directory file as the argument, then the file's parent directory is opened.
+* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift
+
+* If `fl` is called with a non-directory file as the argument, then the file's parent directory is opened.

plugins/gas/README.md

@@ -4,6 +4,7 @@ This plugin adds autocompletion for the [gas](http://walle.github.com/gas) comma
 a utility to manage Git authors.
 
 To use it, add `gas` to the plugins array of your zshrc file:
+
 ```zsh
 plugins=(... gas)
 ```

plugins/geeknote/README.md

-ZSH-Geeknote
-============
+# Geeknote plugin
 
-[Geeknote](https://github.com/VitaliyRodnenko/geeknote) plugin for oh-my-zsh.
+This plugin provides autocompletion for [Geeknote](https://github.com/VitaliyRodnenko/geeknote)
+and an alias for `geeknote` called `gn`.
 
-Plugins provides:
+To use it, add `geeknote` to the plugins array in your zshrc file:
 
-* auto completion of commands and their options
-* alias `gn`
-
-## Installation
-
-### oh-my-zsh
-This plugin is already bundled in oh-my-zsh. To enable just configure plugin definition
-
-    plugins=( ... geeknote ...)
-
-### Antigen
-Use [Antigen's](https://github.com/zsh-users/antigen) bundle command to install by adding `antigen bundle s7anley/zsh-geeknote` to your `.zshrc` along with your other plugins.
+```zsh
+plugins=( ... geeknote ...)
+```

plugins/git-extras/README.md

@@ -2,10 +2,16 @@
 
 This plugin provides completion definitions for some of the commands defined by [git-extras](https://github.com/tj/git-extras).
 
-##  Setup notes
+To use it, add `git-extras` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-extras)
+```
+
+## Setup notes
 
 The completions work by augmenting the `_git` completion provided by `zsh`. This only works with the `zsh`-provided `_git`, not the `_git` provided by `git` itself. If you have both `zsh` and `git` installed, you need to make sure that the `zsh`-provided `_git` takes precedence.
 
 ### OS X Homebrew Setup
 
-On OS X with Homebrew, you need to install `git` with `brew install git --without-completions`. Otherwise, `git`'s `_git` will take precedence, and you won't see the completions for `git-extras` commands.
+**NOTE:** this no longer works on current Homebrew distributions of git. ~~On OS X with Homebrew, you need to install `git` with `brew install git --without-completions`. Otherwise, `git`'s `_git` will take precedence, and you won't see the completions for `git-extras` commands.~~

plugins/git-flow/README.md

 # Git-Flow plugin
 
-This plugin adds completion and aliases for the `git-flow` command. More information
-at https://github.com/nvie/gitflow.
+This plugin adds completion and aliases for the [`git-flow` command](https://github.com/nvie/gitflow).
 
-Enable git-flow plugin in your zshrc file:
-```
+To use it, add `git-flow` to the plugins array in your zshrc file:
+
+```zsh
 plugins=(... git-flow)
 ```
 
 ## Aliases
 
-More information about `git-flow` commands:
-https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
-
 | Alias   | Command                    | Description                            |
 |---------|----------------------------|----------------------------------------|
 | `gfl`   | `git flow`                 | Git-Flow command                       |
@@ -30,3 +27,5 @@ https://github.com/nvie/gitflow/wiki/Command-Line-Arguments
 | `gflfp` | `git flow feature publish` | Publish feature: `gflfp <name>`        |
 | `gflhf` | `git flow hotfix finish`   | Finish hotfix: `gflhf <version>`       |
 | `gflrf` | `git flow release finish`  | Finish release: `gflrf <version>`      |
+
+[More information about `git-flow` commands](https://github.com/nvie/gitflow/wiki/Command-Line-Arguments).

plugins/git-remote-branch/README.md

@@ -3,8 +3,9 @@
 This plugin adds completion for [`grb`](https://github.com/webmat/git_remote_branch),
 or `git_remote_branch`.
 
-To use it, add `git-remote-branch` to the plugins array of your `.zshrc` file:
-```
+To use it, add `git-remote-branch` to the plugins array of your zshrc file:
+
+```zsh
 plugins=(... git-remote-branch)
 ```
 

plugins/git/README.md

@@ -172,7 +172,7 @@ plugins=(... git)
 | gwch                 | git whatchanged -p --abbrev-commit --pretty=medium                                                                               |
 | gwip                 | git add -A; git rm $(git ls-files --deleted) 2> /dev/null; git commit --no-verify --no-gpg-sign -m "--wip-- [skip ci]"           |
 
-### Deprecated
+### Deprecated aliases
 
 These are aliases that have been removed, renamed, or otherwise modified in a way that may, or may not, receive further support.
 
@@ -211,7 +211,7 @@ These features allow to pause a branch development and switch to another one (_"
 | gwip             | Commit wip branch                               |
 | gunwip           | Uncommit wip branch                             |
 
-### Deprecated
+### Deprecated functions
 
 | Command                | Description                             | Reason                                                          |
 |:-----------------------|:----------------------------------------|:----------------------------------------------------------------|

plugins/gitfast/README.md

 # Gitfast plugin
 
-This plugin adds completion for Git, using the zsh completion from git.git folks, which is much faster than the official one from zsh. A lot of zsh-specific features are not supported, like descriptions for every argument, but everything the bash completion has, this one does too (as it is using it behind the scenes). Not only is it faster, it should be more robust, and updated regularly to the latest git upstream version..
+This plugin adds completion for Git, using the zsh completion from git.git folks, which is much faster than the official one from zsh. A lot of zsh-specific features are not supported, like descriptions for every argument, but everything the bash completion has, this one does too (as it is using it behind the scenes). Not only is it faster, it should be more robust, and updated regularly to the latest git upstream version.
 
 To use it, add `gitfast` to the plugins array in your zshrc file:
 

plugins/github/README.md

-#  github
+# github plugin
 
 This plugin supports working with GitHub from the command line. It provides a few things:
 
@@ -6,7 +6,7 @@ This plugin supports working with GitHub from the command line. It provides a fe
 * Completion for the `github` Ruby gem.
 * Convenience functions for working with repos and URLs.
 
-###  Functions
+### Functions
 
 * `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub
 * `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub
@@ -14,13 +14,13 @@ This plugin supports working with GitHub from the command line. It provides a fe
 * `git.io` - Shortens a URL using [git.io](https://git.io)
 
 
-##  Installation
+## Installation
 
 [Hub](https://github.com/github/hub) needs to be installed if you want to use it. On OS X with Homebrew, this can be done with `brew install hub`. The `hub` completion definition needs to be added to your `$FPATH` before initializing OMZ.
 
 The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it.
 
-###  Configuration
+### Configuration
 
 These settings affect `github`'s behavior.
 
@@ -35,7 +35,7 @@ These settings affect `github`'s behavior.
 
 See `man hub` for more details.
 
-###  Homebrew installation note
+### Homebrew installation note
 
 If you have installed `hub` using Homebrew, its completions may not be on your `$FPATH` if you are using the system `zsh`. Homebrew installs `zsh` completion definitions to `/usr/local/share/zsh/site-functions`, which will be on `$FPATH` for the Homebrew-installed `zsh`, but not for the system `zsh`. If you want it to work with the system `zsh`, add this to your `~/.zshrc` before it sources `oh-my-zsh.sh`.
 

plugins/gpg-agent/README.md

@@ -3,6 +3,7 @@
 Enables [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/) if it is not running.
 
 To use it, add gpg-agent to the plugins array of your zshrc file:
-```
+
+```zsh
 plugins=(... gpg-agent)
 ```

plugins/gradle/README.md

@@ -18,6 +18,7 @@ whether it is `gradle` or `gradlew`. It also supports being called from
 any directory inside the root project directory.
 
 Examples:
+
 ```zsh
 gradle test
 gradle build

plugins/grails/README.md

@@ -14,58 +14,3 @@ It looks for scripts in the following paths:
 - `~/.grails/scripts`
 - `./scripts`
 - `./plugins/*/scripts`
-
-## Grails Commands
-- `add-proxy`
-- `alias`
-- `bootstrap`
-- `bug-report`
-- `clean`
-- `clean-all`
-- `clear-proxy`
-- `compile`
-- `console`
-- `create-app`
-- `create-controller`
-- `create-domain-class`
-- `create-filters`
-- `create-integration-test`
-- `create-multi-project-build`
-- `create-plugin`
-- `create-pom`
-- `create-script`
-- `create-service`
-- `create-tag-lib`
-- `create-unit-test`
-- `dependency-report`
-- `doc`
-- `help`
-- `init`
-- `install-app-templates`
-- `install-dependency`
-- `install-plugin`
-- `install-templates`
-- `integrate-with`
-- `interactive`
-- `list-plugin-updates`
-- `list-plugins`
-- `migrate-docs`
-- `package`
-- `package-plugin`
-- `plugin-info`
-- `refresh-dependencies`
-- `remove-proxy`
-- `run-app`
-- `run-script`
-- `run-war`
-- `set-grails-version`
-- `set-proxy`
-- `set-version`
-- `shell`
-- `stats`
-- `stop-app`
-- `test-app`
-- `uninstall-plugin`
-- `url-mappings-report`
-- `war`
-- `wrapper`

plugins/history/README.md

-## history
+# history plugin
 
 Provides a couple of convenient aliases for using the `history` command to examine your command line history.
 
-### Requirements
+To use it, add `history` to the plugins array in your zshrc file:
 
-* None.
+```zsh
+plugins=(... history)
+```
 
-### Usage
+## Aliases
 
-* If `h` is called, your command history is listed. Equivalent to using `history`
-
-* If `hsi` is called with an argument, a **case insensitive** `grep` search is performed on your command history, looking for commands that match the argument provided
-
-* If `hsi` is called without an argument you will help on `grep` arguments
+| Alias | Command              | Description                                                      |
+|-------|----------------------|------------------------------------------------------------------|
+| `h`   | `history`            | Prints your command history                                      |
+| `hs`  | `history \| grep`    | Use grep to search your command history                          |
+| `hsi` | `history \| grep -i` | Use grep to do a case-insensitive search of your command history |
\ No newline at end of file

plugins/history/history.plugin.zsh

 alias h='history'
-
-function hs
-{
-    history | grep $*
-}
-
-alias hsi='hs -i'
+alias hs='history | grep'
+alias hsi='history | grep -i'

plugins/httpie/README.md

@@ -11,5 +11,4 @@ plugins=(... httpie)
 
 It uses completion from [zsh-completions](https://github.com/zsh-users/zsh-completions).
 
-
 **Maintainer:** [lululau](https://github.com/lululau)

plugins/jsontools/README.md

@@ -2,41 +2,47 @@
 
 Handy command line tools for dealing with json data.
 
-## Tools
+To use it, add `jsontools` to the plugins array in your zshrc file:
 
-- **pp_json** - pretty prints json
-- **is_json** - returns true if valid json; false otherwise
-- **urlencode_json** - returns a url encoded string for the given json 
-- **urldecode_json** - returns decoded json for the given url encoded string
+```zsh
+plugins=(... jsontools)
+```
 
 ## Usage
-Usage is simple...just take your json data and pipe it into the appropriate jsontool.
-```sh
-<json data> | <jsontools tool>
-```
-## Examples
 
-##### pp_json
+Usage is simple... just take your json data and pipe it into the appropriate jsontool:
+
+- `pp_json`: pretty prints json.
+- `is_json`: returns true if valid json; false otherwise.
+- `urlencode_json`: returns a url encoded string for the given json.
+- `urldecode_json`: returns decoded json for the given url encoded string.
+
+### Examples
+
+- **pp_json**:
 
 ```sh
 # curl json data and pretty print the results
 curl https://coderwall.com/bobwilliams.json | pp_json
 ```
 
-##### is_json
+- **is_json**:
+
 ```sh
 # pretty print the contents of an existing json file
 less data.json | is_json
 ```
 
-##### urlencode_json
+- **urlencode_json**:
+
 ```sh
 # json data directly from the command line
 echo '{"b":2, "a":1}' | urlencode_json
 ```
 
-##### urldecode_json
+- **urldecode_json**:
+
 ```sh
 # url encoded string to decode
 echo '%7B%22b%22:2,%20%22a%22:1%7D%0A' | urldecode_json
-```
+```
\ No newline at end of file

plugins/laravel4/README.md

@@ -10,9 +10,9 @@ plugins=(... laravel4)
 
 ## Aliases
 
-| Alias | Command                                   | Description                                     |
-|-----------|-------------------------------------------|-------------------------------------------------------------|
-| la4       | `php artisan`                             | Main Artisan command                        |
-| la4dump   | `php artisan dump-autoload`               | Regenerate framework autoload files         |
-| la4cache  | `php artisan cache:clear`                 | Flush the application cache                 |
-| la4routes | `php artisan routes`                      | List all registered routes                  |
+| Alias     | Command                     | Description                         |
+|-----------|-----------------------------|-------------------------------------|
+| la4       | `php artisan`               | Main Artisan command                |
+| la4dump   | `php artisan dump-autoload` | Regenerate framework autoload files |
+| la4cache  | `php artisan cache:clear`   | Flush the application cache         |
+| la4routes | `php artisan routes`        | List all registered routes          |

plugins/last-working-dir/README.md

@@ -6,4 +6,10 @@ for new shells, unless:
 - The plugin is already loaded.
 - The current `$PWD` is not `$HOME`.
 
-Adds `lwd` function to jump to the last working directory.
+Also adds `lwd` function to jump to the last working directory.
+
+To use it, add `last-working-dir` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... last-working-dir)
+```