Fixed mojohaus#15 Add README.md

tavin · Jul 29, 2015 · d78f8dc · d78f8dc
1 parent c99ecae
commit d78f8dc
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# MojoHaus Versions Maven Plugin
+
+This is the [versions-maven-plugin](http://www.mojohaus.org/versions-maven-plugin/).
+
+[![Build Status](https://travis-ci.org/mojohaus/versions-maven-plugin.svg?branch=master)](https://travis-ci.org/mojohaus/versions-maven-plugin)
+
+## Releasing
+
+* Make sure `gpg-agent` is running.
+* Execute `mvn -B release:prepare release:perform`
+
+For publishing the site do the following:
+
+```
+cd target/checkout
+mvn verify site site:stage scm-publish:publish-scm
+```