Clean up plugin READMEs and a few plugins

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

plugins/sprunge/README.md

@@ -3,7 +3,8 @@
 This plugin uploads data and fetch URL from the pastebin http://sprunge.us
 
 To enable it, add 'sprunge' to your plugins:
-```
+
+```zsh
 plugins=(... sprunge)
 ```
 

plugins/sudo/README.md

@@ -2,25 +2,13 @@
 
 Easily prefix your current or previous commands with `sudo` by pressing <kbd>esc</kbd> twice
 
-## Enabling the plugin
+To use it, add `sudo` to the plugins array in your zshrc file:
 
-1.  Open your `.zshrc` file and add `sudo` in the plugins section:
-
-    ```zsh
-    plugins=(
-        # all your enabled plugins
-        sudo
-    )
-    ```
-
-2.  Restart your shell or restart your Terminal session:
-
-    ```console
-    $ exec zsh
-    $
-    ```
+```zsh
+plugins=(... sudo)
+```
 
-## Usage examples
+## Usage
 
 ### Current typed commands
 

plugins/supervisor/README.md

@@ -5,6 +5,7 @@ Supervisor is a client/server system that allows its users to monitor and contro
 of processes on UNIX-like operating systems.
 
 To use it, add `supervisor` to the plugins array in your zshrc file:
+
 ```zsh
 plugins=(... supervisor)
 ```

plugins/svn-fast-info/README.md

@@ -4,6 +4,7 @@ Faster alternative to the main SVN plugin implementation. Works with svn 1.6 and
 Use as a drop-in replacement to the svn plugin, not as complementary.
 
 To use it, add `svn-fast-info` to the plugins array in your zshrc file:
+
 ```zsh
 plugins=(... svn-fast-info)
 ```

plugins/taskwarrior/README.md

@@ -4,10 +4,15 @@ This plugin adds smart tab completion for [TaskWarrior](https://taskwarrior.org/
 It uses the zsh tab completion script (`_task`) shipped with TaskWarrior for the
 completion definitions.
 
-The latest version pulled in from the official project is of January 1st, 2015.
+To use it, add `taskwarrior` to the plugins array in your zshrc file:
 
+```zsh
+plugins=(... taskwarrior)
+```
 
 ## Examples
 
 Typing `task [TAB]` will give you a list of commands, `task 66[TAB]` shows a
 list of available modifications for that task, etcetera.
+
+The latest version pulled in from the official project is of January 1st, 2015.

plugins/textmate/README.md

@@ -3,7 +3,8 @@
 The plugin adds a function for the [TextMate](https://macromates.com) editor.
 
 To use it, add `textmate` to the plugins array of your zshrc file:
-```
+
+```zsh
 plugins=(... textmate)
 ```
 

plugins/tmux/README.md

@@ -7,7 +7,8 @@ To use it add `tmux` to the plugins array in your zshrc file.
 plugins=(... tmux)
 ```
 
-The plugin also supports the following - 
+The plugin also supports the following:
+
 - determines if tmux is installed or not, if not, prompts user to install tmux
 - determines if the terminal supports the 256 colors or not, sets the appropriate configuration variable
 - sets the correct local config file to use
@@ -24,7 +25,6 @@ The plugin also supports the following -
 | `tkss` | tmux kill-session -t   | Terminate named running tmux session                      |
 | `tmux` | `_zsh_tmux_plugin_run` | Start a new tmux session                                  |
 
-
 ## Configuration Variables
 
 | Variable                            | Description                                                                   |

plugins/tmuxinator/README.md

@@ -12,8 +12,8 @@ plugins=(... tmuxinator)
 ## Aliases
 
 | Alias | Command          | Description              |
-| ------ | ---------------- | ------------------------ |
-| `txs ` | tmuxinator start | Start Tmuxinator         |
-| `txo ` | tmuxinator open  | Open project for editing |
-| `txn ` | tmuxinator new   | Create project           |
-| `txl ` | tmuxinator list  | List projects            |
+| ----- | ---------------- | ------------------------ |
+| `txs` | tmuxinator start | Start Tmuxinator         |
+| `txo` | tmuxinator open  | Open project for editing |
+| `txn` | tmuxinator new   | Create project           |
+| `txl` | tmuxinator list  | List projects            |

plugins/wakeonlan/README → plugins/wakeonlan/README.md

+# wakeonlan
+
 This plugin provides a wrapper around the "wakeonlan" tool available from most
-distributions' package repositories, or from the following website:
+distributions' package repositories, or from [the following website](https://github.com/jpoliv/wakeonlan).
+
+To use it, add `wakeonlan` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... wakeonlan)
+```
 
-http://gsd.di.uminho.pt/jpo/software/wakeonlan/
+## Usage
 
-In order to use this wrapper, create the ~/.wakeonlan directory, and place in
+In order to use this wrapper, create the `~/.wakeonlan` directory, and place in
 that directory one file for each device you would like to be able to wake. Give
 the file a name that describes the device, such as its hostname. Each file
 should contain a line with the mac address of the target device and the network
@@ -12,15 +20,21 @@ broadcast address.
 For instance, there might be a file ~/.wakeonlan/leto with the following
 contents:
 
+```
 00:11:22:33:44:55:66 192.168.0.255
+```
 
 To wake that device, use the following command:
 
-# wake leto
+```console
+$ wake leto
+```
 
 The available device names will be autocompleted, so:
 
-# wake <tab>
+```console
+$ wake <tab>
+```
 
 ...will suggest "leto", along with any other configuration files that were
 placed in the ~/.wakeonlan directory.

plugins/yii/README.md

@@ -3,7 +3,8 @@
 The plugin adds autocomplete commands and subcommands for [yii](https://www.yiiframework.com/).
 
 To use it, add `yii` to the plugins array of your zshrc file:
-```
+
+```zsh
 plugins=(... yii)
 ```
 

plugins/yum/README.md

@@ -4,7 +4,7 @@ This plugin adds useful aliases for common [Yum](http://yum.baseurl.org/) comman
 
 To use it, add `yum` to the plugins array in your zshrc file:
 
-```
+```zsh
 plugins=(... yum)
 ```
 

plugins/zeus/README.md

-## zeus
-**Maintainer:** [b4mboo](https://github.com/b4mboo)
-
-* `zi` aliases `zeus init`
-* `zinit` aliases `zeus init`
-
-* `zs` aliases `zeus start`
-* `ztart` aliases `zeus start`
-
-* `zc` aliases `zeus console`
-* `zonsole` aliases `zeus console`
-
-* `zsr` aliases `zeus server`
-* `zerver` aliases `zeus server`
-
-* `zr` aliases `zeus rake`
-* `zake` aliases `zeus rake`
-
-* `zg` aliases `zeus generate`
-* `zenerate` aliases `zeus generate`
-
-* `zrn` aliases `zeus runner`
-* `zunner` aliases `zeus runner`
-
-* `zcu` aliases `zeus cucumber`
-* `zucumber` aliases `zeus cucumber`
-* `zwip` aliases `zeus cucumber --profile wip`
-
-* `zspec` aliases `zeus rspec`
-
-* `zt` aliases `zeus test`
-* `zest` aliases `zeus test`
-
-* `zu` aliases `zeus test test/unit/*`
-* `zunits` aliases `zeus test test/unit/*`
-
-* `zf` aliases `zeus test test/functional/*`
-* `zunctional` aliases `zeus test test/functional/*`
-
-* `za` aliases `zeus test test/unit/*; zeus test test/functional/; zeus cucumber`
-* `zall` aliases `zeus test test/unit/*; zeus test test/functional/; zeus cucumber`
-
-* `zsw` aliases `rm .zeus.sock`
-* `zweep` aliases `rm .zeus.sock`
-
-* `zdbr` aliases `zeus rake db:reset db:test:prepare`
-* `zdbreset` aliases `zeus rake db:reset db:test:prepare`
-
-* `zdbm` aliases `zeus rake db:migrate db:test:prepare`
-* `zdbmigrate` aliases `zeus rake db:migrate db:test:prepare`
-
-* `zdbc` aliases `zeus rake db:create`
-
-* `zdbcm` aliases `zeus rake db:create db:migrate db:test:prepare`
-
-## Installation
-Add zeus to the plugins line of your `.zshconfig` file (e.g. `plugins=(rails git zeus)`)
+# zeus plugin
+
+[Zeus](https://github.com/burke/zeus) preloads your Rails environment and forks that
+process whenever needed. This effectively speeds up Rails' boot process to under 1 sec.
+This plugin adds autocompletion for zeus and aliases for common usage.
+
+To use it, add `zeus` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... zeus)
+```
+
+You also need to have the `zeus` gem installed.
+
+| Alias        | Command                                                            |
+|:-------------|:-------------------------------------------------------------------|
+| _zi_         | `zeus init`                                                        |
+| _zinit_      | `zeus init`                                                        |
+| _zs_         | `zeus start`                                                       |
+| _ztart_      | `zeus start`                                                       |
+| _zc_         | `zeus console`                                                     |
+| _zonsole_    | `zeus console`                                                     |
+| _zsr_        | `zeus server`                                                      |
+| _zerver_     | `zeus server`                                                      |
+| _zr_         | `noglob zeus rake`                                                 |
+| _zake_       | `noglob zeus rake`                                                 |
+| _zg_         | `zeus generate`                                                    |
+| _zenerate_   | `zeus generate`                                                    |
+| _zrn_        | `zeus runner`                                                      |
+| _zunner_     | `zeus runner`                                                      |
+| _zcu_        | `zeus cucumber`                                                    |
+| _zucumber_   | `zeus cucumber`                                                    |
+| _zwip_       | `zeus cucumber --profile wip`                                      |
+| _zspec_      | `zeus rspec`                                                       |
+| _zt_         | `zeus test`                                                        |
+| _zest_       | `zeus test`                                                        |
+| _zu_         | `zeus test test/unit/*`                                            |
+| _zunits_     | `zeus test test/unit/*`                                            |
+| _zf_         | `zeus test test/functional/*`                                      |
+| _zunctional_ | `zeus test test/functional/*`                                      |
+| _za_         | `zeus test test/unit/*; zeus test test/functional/; zeus cucumber` |
+| _zall_       | `zeus test test/unit/*; zeus test test/functional/; zeus cucumber` |
+| _zsw_        | `rm .zeus.sock`                                                    |
+| _zweep_      | `rm .zeus.sock`                                                    |
+| _zdbr_       | `zeus rake db:reset db:test:prepare`                               |
+| _zdbreset_   | `zeus rake db:reset db:test:prepare`                               |
+| _zdbm_       | `zeus rake db:migrate db:test:prepare`                             |
+| _zdbmigrate_ | `zeus rake db:migrate db:test:prepare`                             |
+| _zdbc_       | `zeus rake db:create`                                              |
+| _zdbcm_      | `zeus rake db:create db:migrate db:test:prepare`                   |