summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc CornellĂ  <marc.cornella@live.com>2018-10-01 12:14:15 +0200
committerGitHub <noreply@github.com>2018-10-01 12:14:15 +0200
commit7f96f4476c922b037eb287af2e727e17653db1ef (patch)
tree4b4d3a7651ea2c0162fe6ed76ff79338d98b7986
parent441595d036cb88555793806cd2a77744dc849de3 (diff)
downloadzsh-7f96f4476c922b037eb287af2e727e17653db1ef.tar.gz
zsh-7f96f4476c922b037eb287af2e727e17653db1ef.tar.bz2
zsh-7f96f4476c922b037eb287af2e727e17653db1ef.zip
jenv: update README
-rw-r--r--plugins/jenv/README.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/plugins/jenv/README.md b/plugins/jenv/README.md
index 8899d21ae..c043c626e 100644
--- a/plugins/jenv/README.md
+++ b/plugins/jenv/README.md
@@ -1,9 +1,9 @@
# 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).
+and [pyenv](https://github.com/yyuu/pyenv).
-This plugin initializes jenv and adds provides the jenv_prompt_info function to add Java
+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:
@@ -11,3 +11,17 @@ 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
+```