From 47be1036d1fac73dfdb00f67d9428ab1a78d0b21 Mon Sep 17 00:00:00 2001
From: nscavell <nick.scavelli@gmail.com>
Date: Wed, 26 Sep 2012 14:09:48 -0400
Subject: [PATCH] Update readme

---
 README | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 5d7c1c5..43138f1 100644
--- a/README
+++ b/README
@@ -1 +1,24 @@
-Project to house RHQ plugins for GateIn.
\ No newline at end of file
+GateIn RHQ
+=============
+
+Project to house RHQ Plugins for [GateIn Portal](http://gatein.org)
+
+Installation
+-----------
+
+`mvn clean install`
+
+Then copy the jar to the RHQ server plugins directory. Have a look at [GateIn RHQ How-To](https://community.jboss.org/wiki/EPPJONRHQPluginHow-to)
+for more information on getting started with this plugin and RHQ.
+
+Also documentation on how to use the plugin within RHQ can be found [here](https://docs.jboss.org/author/display/GTNPORTAL34/Administration+and+Monitoring)
+
+Compatible Portal Platforms
+-----------
+* GateIn 3.4 running on AS5 or AS6
+* EPP 5.2.x
+
+Compatible RHQ Servers
+-----------
+* RHQ 4.2.x
+