c64964469559cea37a19cdfe847a95f41562993f
- Author
- MasterOfTheTiger <ted.jameson@pm.me>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
ruby: add README (#7212)
Diff
1diff --git a/plugins/ruby/README.md b/plugins/ruby/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..ad2755bbf29c2677d05438bb8179a5fc876a3137
4--- /dev/null
5+++ b/plugins/ruby/README.md
6@@ -0,0 +1,20 @@
7+# Ruby plugin
8+
9+This plugin adds aliases for common commands used in dealing with [Ruby](https://www.ruby-lang.org/en/) and [gem packages](https://rubygems.org/).
10+
11+To use it, add `ruby` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... ruby)
15+```
16+
17+## Aliases
18+
19+| Alias | Command | Description |
20+|-------|----------------------------------------|------------------------------------------------------|
21+| rb | `ruby` | The Ruby command |
22+| sgem | `sudo gem` | Run sudo gem on the system ruby, not the active ruby |
23+| rfind | `find . -name "*.rb" \| xargs grep -n` | Find ruby file |
24+| gin | `gem install` | Install a gem into the local repository |
25+| gun | `gem uninstall` | Uninstall gems from the local repository |
26+| gli | `gem list` | Display gems installed locally |