1 files changed, 27 insertions, 0 deletions
diff --git a/plugins/jenv/README.md b/plugins/jenv/README.md
new file mode 100644
index 000000000..c043c626e
--- /dev/null
+++ b/plugins/jenv/README.md
@@ -0,0 +1,27 @@
+# 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 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)
+```
+
+## Theme example
+
+You can modify your `$PROMPT` or `$RPROMPT` variables to run `jenv_prompt_info`.
+
+For example:
+```
+PROMPT="%~$ "
+RPROMPT='$(jenv_prompt_info)'
+```
+changes your prompt to:
+```
+~/java/project$ ▋                                       oracle64-1.6.0.39
+```