From 77ad69e0805d722e673ae3f3c655788188ec1751 Mon Sep 17 00:00:00 2001
From: Zach Whitten <zwhitten+github@gmail.com>
Date: Tue, 1 Oct 2019 15:21:05 -0400
Subject: jruby: add README (#8190)

---
 plugins/jruby/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 plugins/jruby/README.md

(limited to 'plugins')

diff --git a/plugins/jruby/README.md b/plugins/jruby/README.md
new file mode 100644
index 000000000..821a46d5e
--- /dev/null
+++ b/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`                                                       |
-- 
cgit v1.2.3-70-g09d2