summaryrefslogtreecommitdiff
path: root/plugins/gem
diff options
context:
space:
mode:
authorZach Whitten <zwhitten@gmail.com>2018-10-04 08:56:43 -0400
committerZach Whitten <zachary@variphy.com>2018-10-04 08:56:43 -0400
commit8d3cafca3e083b9ea03ffcb096f7cf7c23bd3d56 (patch)
treed7b89ffd63da981805d3afed0fcc1ecfc016352e /plugins/gem
parent6f24f4a18ae4c12102a1ec0621a51fc24f0ffe8c (diff)
downloadzsh-8d3cafca3e083b9ea03ffcb096f7cf7c23bd3d56.tar.gz
zsh-8d3cafca3e083b9ea03ffcb096f7cf7c23bd3d56.tar.bz2
zsh-8d3cafca3e083b9ea03ffcb096f7cf7c23bd3d56.zip
Add Gem README
Diffstat (limited to 'plugins/gem')
-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` |
+