Browse Source

jruby: add README (#8190)

Zach Whitten 4 years ago
parent
commit
77ad69e080
1 changed files with 21 additions and 0 deletions
  1. 21 0
      plugins/jruby/README.md

+ 21 - 0
plugins/jruby/README.md

@@ -0,0 +1,21 @@
+# JRuby plugin
+
+This plugin adds aliases for [JRuby](https://www.jruby.org/).
+
+To use it, add `jruby` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... jruby)
+```
+
+## Requirements
+
+This plugin assumes you already have jruby installed and available in your [path](https://www.jruby.org/getting-started).
+
+## Aliases
+
+| Alias        | Command                                                          |
+| ------------ | ---------------------------------------------------------------- |
+| `jrspec`     | `jruby --debug -S rspec --debug`                                 |
+| `jprofile`   | `jruby --profile.api -S rspec`                                   |
+| `jexec`      | `jruby -S`                                                       |