summaryrefslogtreecommitdiffstats
path: root/zsh/oh-my-zsh/plugins/gem/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
commitaf120ab348f2e1a5a39dec035ed9dcf84189a64e (patch)
tree2a3aadd7ce1b7b771dfe3fe7c983569726c8d7ed /zsh/oh-my-zsh/plugins/gem/README.md
downloaddotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.gz
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.bz2
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.zip
dotfiles
Diffstat (limited to 'zsh/oh-my-zsh/plugins/gem/README.md')
-rw-r--r--zsh/oh-my-zsh/plugins/gem/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/zsh/oh-my-zsh/plugins/gem/README.md b/zsh/oh-my-zsh/plugins/gem/README.md
new file mode 100644
index 0000000..decd87b
--- /dev/null
+++ b/zsh/oh-my-zsh/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 |