Improvements for the readme file

plugins/drush/README.md

@@ -1,31 +1,68 @@
-# Drush plugin #
+# Drush
 
-## Description ##
+## Description
 This plugin offers aliases and functions to make the work with drush easier and more productive.
 
-## How to use ##
+To enable it, add the `drush` to your `plugins` array in `~/.zshrc`:
+
+```zsh
+plugins=(... drush)
 ```
-# Aliases, sorted alphabetically.
+
-drca  #Clear all drupal caches.
+## Aliases
-drcb  #Clear block cache.
+| Alias | Description                                                           | Command                     |
-drcg  #Clear registry cache.
+|-------|-----------------------------------------------------------------------|-----------------------------|
-drcj  #Clear css-js cache.
+| drca  | Clear all drupal caches.                                              | drush cc all                |
-drcm  #Clear menu cache.
+| drcb  | Clear block cache.                                                    | drush cc block              |
-drcml #Clear module-list cache.
+| drcg  | Clear registry cache.                                                 | drush cc registry           |
-drcr  #Run all cron hooks in all active modules for specified site.
+| drcj  | Clear css-js cache.                                                   | drush cc css-js             |
-drct  #Clear theme-registry cache.
+| drcm  | Clear menu cache.                                                     | drush cc menu               |
-drcv  #Clear views cache.
+| drcml | Clear module-list cache.                                              | drush cc module-list        |
-drif  #Flush all derived images.
+| drcr  | Run all cron hooks in all active modules for specified site.          | drush core-cron             |
-drpm  #Show a list of available modules.
+| drct  | Clear theme-registry cache.                                           | drush cc theme-registry     |
-drst  #Provides a birds-eye view of the current Drupal installation, if any.
+| drcv  | Clear views cache. (Make sure that the views module is enabled)       | drush cc views              |
-drup  #Apply any database updates required (as with running update.php).
+| drif  | Flush all derived images.                                             | drush image-flush --all     |
-drups #List any pending database updates.
+| drpm  | Show a list of available modules.                                     | drush pm-list --type=module |
-drv   #Show drush version.
+| drst  | Provides a birds-eye view of the current Drupal installation, if any. | drush core-status           |
+| drup  | Apply any database updates required (as with running update.php).     | drush updatedb              |
+| drups | List any pending database updates.                                    | drush updatedb-status       |
+| drv   | Show drush version.                                                   | drush version               |
+
+
+## Functions
+
+### dren
+Download and enable one or more extensions (modules or themes).
+Must be invoked with one or more parameters. e.g.:
+`dren devel` or `dren devel module_filter views`
+
+### drf
+Edit drushrc, site alias, and Drupal settings.php files.
+Can be invoked with one or without parameters. e.g.:
+`drf 1`
+
+### dris
+Disable one or more extensions (modules or themes)
+Must be invoked with one or more parameters. e.g.:
+`dris devel` or `dris devel module_filter views`
+
+### drpu
+Uninstall one or more modules.
+Must be invoked with one or more parameters. e.g.:
+`drpu devel` or `drpu devel module_filter views`
+
+## Additional features
+
+### Autocomplete
+The [completion script for drush](https://github.com/drush-ops/drush/blob/8.0.1/drush.complete.sh) comes enabled with this plugin.
+So, it is possible to type a command:
 ```
+drush sql
 ```
-# Functions, sorted alphabetically.
+
-dren #Download and enable one or more extensions (modules or themes).
+And as soon as the tab key is pressed, the script will display the available commands:
-drf #Edit drushrc, site alias, and Drupal settings.php files. Can be called with a parameter e.g.: drf 2
+```
-dris #Disable one or more extensions (modules or themes).
+drush sql
-drpu #Uninstall one or more modules.
+sqlc           sql-conf       sql-create     sql-dump       sql-query      sql-sanitize                
+sql-cli        sql-connect    sql-drop       sqlq           sqlsan         sql-sync
 ```

plugins/drush/drush.plugin.zsh

@@ -39,12 +39,12 @@ alias drcml="drush cc module-list"
 alias drcr="drush core-cron"
 alias drct="drush cc theme-registry"
 alias drcv="drush cc views"
+alias drif="drush image-flush --all"
 alias drpm="drush pm-list --type=module"
 alias drst="drush core-status"
 alias drup="drush updatedb"
 alias drups="drush updatedb-status"
 alias drv="drush version"
-alias drif="drush image-flush --all"
 
 # Enable drush autocomplete support
 autoload bashcompinit