summaryrefslogtreecommitdiff
path: root/plugins/jenv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/jenv/README.md')
-rw-r--r--plugins/jenv/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/jenv/README.md b/plugins/jenv/README.md
new file mode 100644
index 000000000..8899d21ae
--- /dev/null
+++ b/plugins/jenv/README.md
@@ -0,0 +1,13 @@
+# jenv plugin
+
+[jenv](https://www.jenv.be/) is a Java version manager similiar to [rbenv](https://github.com/rbenv/rbenv)
+and [pyenv]|(https://github.com/yyuu/pyenv).
+
+This plugin initializes jenv and adds provides the jenv_prompt_info function to add Java
+version information to prompts.
+
+To use, add `jenv` to your plugins array in your zshrc file:
+
+```zsh
+plugins=(... jenv)
+```