summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/bower/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/plugins/bower/README.md b/plugins/bower/README.md
new file mode 100644
index 000000000..743b6a0ea
--- /dev/null
+++ b/plugins/bower/README.md
@@ -0,0 +1,18 @@
+# Bower plugin
+
+This plugin adds completion for [Bower](https://bower.io/) and a few useful aliases for common Bower commands.
+
+To use it, add `bower` to the plugins array in your zshrc file:
+
+```
+plugins=(... bower)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-------|-----------------|--------------------------------------------------------|
+| bi | `bower install` | Installs the project dependencies listed in bower.json |
+| bl | `bower list` | List local packages and possible updates |
+| bs | `bower search` | Finds all packages or a specific package. |
+