summaryrefslogtreecommitdiff
path: root/plugins/bower/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-05-08 20:40:36 +0200
committerGitHub <noreply@github.com>2019-05-08 20:40:36 +0200
commit0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534 (patch)
tree946d9f8b758ebdd63da96152ca56b154c99068da /plugins/bower/README.md
parentafb028763cf40fc339e49011b2cba124dc108fcb (diff)
parentebc700be9b2fa7ae770a644093a5c46a8e323726 (diff)
downloadzsh-0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534.tar.gz
zsh-0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534.tar.bz2
zsh-0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534.zip
Merge branch 'master' into master
Diffstat (limited to 'plugins/bower/README.md')
-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. |
+