summaryrefslogtreecommitdiff
path: root/plugins/pm2/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/pm2/README.md')
-rw-r--r--plugins/pm2/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/pm2/README.md b/plugins/pm2/README.md
new file mode 100644
index 000000000..5dfd540b6
--- /dev/null
+++ b/plugins/pm2/README.md
@@ -0,0 +1,19 @@
+# pm2 plugin
+
+The plugin adds several aliases and completions for common [pm2](http://pm2.keymetrics.io/) commands.
+
+To use it, add `pm2` to the plugins array of your zshrc file:
+```
+plugins=(... pm2)
+```
+
+## Aliases
+
+| Alias | Command |
+|--------|----------------------|
+| p2s | `pm2 start` |
+| p2o | `pm2 stop` |
+| p2d | `pm2 delete` |
+| p2r | `pm2 restart` |
+| p2i | `pm2 list` |
+| p2l | `pm2 logs` |