From 944d2b919c141a36583d9beecae23a53160c0d6c Mon Sep 17 00:00:00 2001
From: Joseph Walton-Rivers <jwalto@essex.ac.uk>
Date: Wed, 26 Oct 2016 15:14:16 +0100
Subject: [PATCH] added readme

---
 readme.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..94a6199
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,32 @@
+# Maven parent pom
+This is a project designed to make building deployable maven JARs easier. It sets up the requirements for central for your project.
+
+## What does it do?
+* Java build version is set at 1.8
+* The release profile (mvn -P release package) will build javadoc and source jars
+* The release profile will prompt you to do GPG signing
+* Sets branding related values (organisation, urls, etc...)
+* Sets the project licence to GPLv3
+* Configures the build for OSSRH deployment
+
+## What should I change?
+If you're using this for your project - there are a few properties you should change:
+
+### What should I change?
+* name - set to the name of your project
+* description - set to a brief description of your project
+* url - set this to your git repo or microsite
+* developers - set this to you (by default it's webpigeon)
+
+## Usage
+Include the following as an element in your pom.xml file:
+
+```xml
+<!-- Use FOSS Galaxy's parent POM to do most of the build setup for us -->
+<parent>
+	<groupId>com.fossgalaxy.common</groupId>
+	<artifactId>parent-pom</artifactId>
+	<version>0.1</version>
+</parent>
+```
+
-- 
GitLab