summaryrefslogtreecommitdiff
path: root/plugins/gem/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/gem/README.md')
-rw-r--r--plugins/gem/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/gem/README.md b/plugins/gem/README.md
new file mode 100644
index 000000000..b2b6038e4
--- /dev/null
+++ b/plugins/gem/README.md
@@ -0,0 +1,17 @@
+## Gem Plugin
+
+This plugin adds completions and aliases for [Gem](https://rubygems.org/). The completions include the common `gem` subcommands as well as the installed gems in the current directory.
+
+To use it, add `gem` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... gem)
+```
+## Aliases
+
+| Alias | Command |
+|-------|-----------------------|
+| gemb | `gem build *.gemspec` |
+| gemp | `gem push *.gem` |
+| gemy | `gem yank $1 -v $2` |
+