ff23aa0bf9851c477b956c89882fdd04e143042e

Author
Nicholas Meriano <nicmeriano@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

n98-magerun: add README (#8200)

Diff

 1diff --git a/plugins/n98-magerun/README.md b/plugins/n98-magerun/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..b0abe474768ba4fbbc7ff3ecd12c8470d0ad797c
 4--- /dev/null
 5+++ b/plugins/n98-magerun/README.md
 6@@ -0,0 +1,21 @@
 7+# n98-magerun plugin
 8+
 9+The swiss army knife for Magento developers, sysadmins and devops. The tool provides a huge set of well tested command line commands which save hours of work time.
10+
11+The [n98-magerun plugin](https://github.com/netz98/n98-magerun) provides many
12+[useful aliases](#aliases) as well as completion for the `n98-magerun` command.
13+
14+Enable it by adding `n98-magerun` to the plugins array in your zshrc file:
15+
16+```zsh
17+plugins=(... n98-magerun)
18+```
19+
20+## Aliases
21+
22+| Alias     | Command                                            | Description                                                                       |
23+| --------- | -------------------------------------------------- | --------------------------------------------------------------------------------- |
24+| n98       | `n98-magerun.phar`                                 | The N98-Magerun phar-file (Version 1)                                             |
25+| n98-2     | `n98-magerun2.phar`                                | The N98-Magerun phar-file (Version 2)                                             |
26+| mage-get  | `wget https://files.magerun.net/n98-magerun.phar`  | Download the latest stable N98-Magerun phar-file from the file-server (Version 1) |
27+| mage2-get | `wget https://files.magerun.net/n98-magerun2.phar` | Download the latest stable N98-Magerun phar-file from the file-server (Version 2) |