summaryrefslogtreecommitdiff
path: root/plugins/mvn/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2016-05-12 13:41:29 +0200
committerMarc Cornellà <marc.cornella@live.com>2016-05-12 13:41:29 +0200
commit30870d87ddc23b633fb99a6542768835c2a66551 (patch)
tree7f566c4d7ec894e05a795a64f1c42166adb4eec0 /plugins/mvn/README.md
parent863675f3d404e345693e8abd77f6136e171d7ed5 (diff)
downloadzsh-30870d87ddc23b633fb99a6542768835c2a66551.tar.gz
zsh-30870d87ddc23b633fb99a6542768835c2a66551.tar.bz2
zsh-30870d87ddc23b633fb99a6542768835c2a66551.zip
Reword and fix formatting of mvn plugin README
Diffstat (limited to 'plugins/mvn/README.md')
-rw-r--r--plugins/mvn/README.md50
1 files changed, 27 insertions, 23 deletions
diff --git a/plugins/mvn/README.md b/plugins/mvn/README.md
index d521064ca..79192bb54 100644
--- a/plugins/mvn/README.md
+++ b/plugins/mvn/README.md
@@ -1,28 +1,32 @@
-## The mvn Plugin
+## Introduction
-The [mvn](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/mvn) plugin provides many [aliases](#Aliases).
+The [mvn plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/mvn) provides many
+[useful aliases](#aliases) as well as completion for the `mvn` command.
-Enable it by adding _mvn_ to the [_plugins array_](https://github.com/robbyrussell/oh-my-zsh/blob/master/templates/zshrc.zsh-template#L48) before sourcing OMZ (see [Plugins](https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins)).
+Enable it by adding `mvn` to the plugins array in your zshrc file:
+```zsh
+plugins=(... mvn)
+```
## Aliases
-| Alias | Command |
-|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------|
-|mvncie|mvn clean install eclipse:eclipse|
-|mvnci|mvn clean install|
-|mvncist|mvn clean install -DskipTests|
-|mvne|mvn eclipse:eclipse|
-|mvnd|mvn deploy|
-|mvnp|mvn package|
-|mvnc|mvn clean|
-|mvncom|mvn compile|
-|mvnct|mvn clean test|
-|mvnt|mvn test|
-|mvnag|mvn archetype:generate|
-|mvn-updates|mvn versions:display-dependency-updates|
-|mvntc7|mvn tomcat7:run|
-|mvnjetty|mvn jetty:run|
-|mvndt|mvn dependency:tree|
-|mvns|mvn site|
-|mvnsrc|mvn dependency:sources|
-|mvndocs|mvn dependency:resolve -Dclassifier=javadoc|
+| Alias | Command |
+|:---------------------|:------------------------------------------------|
+| `mvncie` | `mvn clean install eclipse:eclipse` |
+| `mvnci` | `mvn clean install` |
+| `mvncist` | `mvn clean install -DskipTests` |
+| `mvne` | `mvn eclipse:eclipse` |
+| `mvnd` | `mvn deploy` |
+| `mvnp` | `mvn package` |
+| `mvnc` | `mvn clean` |
+| `mvncom` | `mvn compile` |
+| `mvnct` | `mvn clean test` |
+| `mvnt` | `mvn test` |
+| `mvnag` | `mvn archetype:generate` |
+| `mvn-updates` | `mvn versions:display-dependency-updates` |
+| `mvntc7` | `mvn tomcat7:run` |
+| `mvnjetty` | `mvn jetty:run` |
+| `mvndt` | `mvn dependency:tree` |
+| `mvns` | `mvn site` |
+| `mvnsrc` | `mvn dependency:sources` |
+| `mvndocs` | `mvn dependency:resolve -Dclassifier=javadoc` |