From 8d3cafca3e083b9ea03ffcb096f7cf7c23bd3d56 Mon Sep 17 00:00:00 2001 From: Zach Whitten Date: Thu, 4 Oct 2018 08:56:43 -0400 Subject: [PATCH 1/3] Add Gem README --- plugins/gem/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 plugins/gem/README.md 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` | + From 6c721e6f95d765ea01b748f47b355febb3bb1715 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= Date: Thu, 4 Oct 2018 23:13:16 +0200 Subject: [PATCH 2/3] add alias descriptions --- plugins/gem/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/plugins/gem/README.md b/plugins/gem/README.md index b2b6038e4..08f52c8ed 100644 --- a/plugins/gem/README.md +++ b/plugins/gem/README.md @@ -7,11 +7,11 @@ 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` | - +| 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 | From 13b87570447a4cc9411d858fa057252f6c166e86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= Date: Thu, 4 Oct 2018 23:13:46 +0200 Subject: [PATCH 3/3] change title to h1 --- plugins/gem/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/gem/README.md b/plugins/gem/README.md index 08f52c8ed..decd87ba3 100644 --- a/plugins/gem/README.md +++ b/plugins/gem/README.md @@ -1,4 +1,4 @@ -## Gem Plugin +# 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.