0e647904ffdd19c697e1c6ab602f65377cb186fe

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

mvn: update documentation

Diff

 1diff --git a/plugins/mvn/README.md b/plugins/mvn/README.md
 2index 3f08c56d818b9ba0a2afea709427b251fb44a6d5..88f5be8ba3a70e889c6a59246be582f7ce5f0197 100644
 3--- a/plugins/mvn/README.md
 4+++ b/plugins/mvn/README.md
 5@@ -1,7 +1,7 @@
 6-## Introduction
 7+# mvn plugin
 8 
 9-The [mvn plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/mvn) provides many
10-[useful aliases](#aliases) as well as completion for the `mvn` command.
11+The mvn plugin provides many [useful aliases](#aliases) as well as completion for
12+the [Apache Maven](https://maven.apache.org/) command (`mvn`).
13 
14 Enable it by adding `mvn` to the plugins array in your zshrc file:
15 ```zsh
16@@ -10,7 +10,7 @@ plugins=(... mvn)
17 
18 ## Aliases
19 
20-The plugin aliases mvn to a either calls `mvnw` ([Maven Wrapper](https://github.com/takari/maven-wrapper))
21+The plugin aliases mvn to a function that calls `mvnw` (the [Maven Wrapper](https://github.com/takari/maven-wrapper))
22 if it's found, or the mvn command otherwise.
23 
24 | Alias                | Command                                         |
25@@ -46,9 +46,13 @@ if it's found, or the mvn command otherwise.
26 
27 ## mvn-color
28 
29-It's a function that wraps the mvn command to colorize it's output. Since Maven 3.5.0
30-the mvn command adds colored output, so this function will be soon removed from the
31-plugin.
32+It's a function that wraps the mvn command to colorize it's output. You can use it in place
33+of the `mvn` command. For example: instead of `mvn test`, use `mvn-color test`.
34 
35-It also has a bug where it won't print when mvn prompts for user input, _e.g._ when
36-using `archetype:generate`. See [#5052](https://github.com/robbyrussell/oh-my-zsh/issues/5052).
37+Since [Maven 3.5.0](https://maven.apache.org/docs/3.5.0/release-notes.html) the mvn command
38+has colored output, so this function will be soon removed from the plugin.
39+
40+### Known bugs
41+
42+It has a bug where it will swallow mvn prompts for user input, _e.g._ when using
43+`archetype:generate`. See [#5052](https://github.com/robbyrussell/oh-my-zsh/issues/5052).