gem: add README (#7224)

This commit is contained in:
Marc Cornellà 2018-10-04 23:14:01 +02:00 committed by GitHub
commit d0d4c654dd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

17
plugins/gem/README.md Normal file
View file

@ -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 |