summaryrefslogtreecommitdiff
path: root/plugins/jenv/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2018-08-19 19:41:49 +0200
committerMarc Cornellà <marc.cornella@live.com>2018-08-19 19:41:49 +0200
commit873dc9cfb8ddc3c9bb398e9dbb27ebea7f6cab81 (patch)
treeb9e3fddfc397d9853e36d96801b776896c7e4a65 /plugins/jenv/README.md
parentcb7a3e38aaa9f395d0a2887d7590375ee4ddf72b (diff)
downloadzsh-873dc9cfb8ddc3c9bb398e9dbb27ebea7f6cab81.tar.gz
zsh-873dc9cfb8ddc3c9bb398e9dbb27ebea7f6cab81.tar.bz2
zsh-873dc9cfb8ddc3c9bb398e9dbb27ebea7f6cab81.zip
jenv: update README
Diffstat (limited to 'plugins/jenv/README.md')
-rw-r--r--plugins/jenv/README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/plugins/jenv/README.md b/plugins/jenv/README.md
index 2f27d6786..8899d21ae 100644
--- a/plugins/jenv/README.md
+++ b/plugins/jenv/README.md
@@ -1,3 +1,13 @@
-# jenv oh-my-zsh plugin
+# jenv plugin
-[jenv](http://www.jenv.be/) is a Java version manager similiar to [rbenv](http://rbenv.org/) 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.
+[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)
+```