summaryrefslogtreecommitdiff
path: root/plugins/gem/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/gem/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/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..decd87ba3
--- /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 | Description |
+|----------------------|-------------------------------|--------------------------------------------|
+| gemb | `gem build *.gemspec` | Build a gem from a gemspec |
+| gemp | `gem push *.gem` | Push a gem up to the gem server |
+| gemy [gem] [version] | `gem yank [gem] -v [version]` | Remove a pushed gem version from the index |