diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2018-10-04 23:14:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-04 23:14:01 +0200 |
| commit | d0d4c654dd38ac19fe0629a5cc88df187658540c (patch) | |
| tree | 78cb1f975808725037b2396f0e2627d63ee1ea11 /plugins/gem | |
| parent | 6f24f4a18ae4c12102a1ec0621a51fc24f0ffe8c (diff) | |
| parent | 13b87570447a4cc9411d858fa057252f6c166e86 (diff) | |
| download | zsh-d0d4c654dd38ac19fe0629a5cc88df187658540c.tar.gz zsh-d0d4c654dd38ac19fe0629a5cc88df187658540c.tar.bz2 zsh-d0d4c654dd38ac19fe0629a5cc88df187658540c.zip | |
gem: add README (#7224)
Diffstat (limited to 'plugins/gem')
| -rw-r--r-- | plugins/gem/README.md | 17 |
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 | |