Add initial README

kevinsawicki · kevinsawicki · commit 7e7607c414af · 2011-09-01T18:24:03.000-07:00
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+This is an example project that uses the [GitHub Maven Plugins](https://github.com/github/maven-plugins).
+
+See the [POM file](https://github.com/kevinsawicki/github-maven-example/blob/master/example/pom.xml)
+for how the plugins are configured.
+
+# Using the downloads plugin
+
+```
+cd example
+mvn clean install
+```
+
+The compiled, source, and Javadoc jars will be uploaded as downloads [here](https://github.com/kevinsawicki/github-maven-example/downloads)
+
+# Using the site plugin
+
+```
+cd example
+mvn clean install
+```
+
+The generated site will be committed and visible [here](http://kevinsawicki.github.com/github-maven-example/)
