77ad69e0805d722e673ae3f3c655788188ec1751

Author
Zach Whitten <zwhitten+github@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

jruby: add README (#8190)

Diff

 1diff --git a/plugins/jruby/README.md b/plugins/jruby/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..821a46d5e35490ce5c120e69c1a2a3db30d471d2
 4--- /dev/null
 5+++ b/plugins/jruby/README.md
 6@@ -0,0 +1,21 @@
 7+# JRuby plugin
 8+
 9+This plugin adds aliases for [JRuby](https://www.jruby.org/).
10+
11+To use it, add `jruby` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... jruby)
15+```
16+
17+## Requirements
18+
19+This plugin assumes you already have jruby installed and available in your [path](https://www.jruby.org/getting-started).
20+
21+## Aliases
22+
23+| Alias        | Command                                                          |
24+| ------------ | ---------------------------------------------------------------- |
25+| `jrspec`     | `jruby --debug -S rspec --debug`                                 |
26+| `jprofile`   | `jruby --profile.api -S rspec`                                   |
27+| `jexec`      | `jruby -S`                                                       |