From 33226c82ebca2dc4142a6825f2f6b7d8fa0d0ca3 Mon Sep 17 00:00:00 2001
From: Thomas Cashman <thomascashman404@gmail.com>
Date: Sun, 30 Jun 2019 19:19:58 +0100
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index bb6af57..a30e3d2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
 # gdx-xml
-LibGDX XML classes extracted into a standalone library
+LibGDX XML classes extracted into a standalone library (i.e. no OpenGL, LWJGL, etc. required)
+
+Mechanism
+----------------------
+
+The gradle build will checkout a specific version of libgdx, copy the compression source files into src/main/java, package renamed from _com.badlogic.gdx.utils_ to _org.mini2Dx.gdx.xml_ and compile the standalone jar.
+
+Usage
+----------------------
+
+```gradle
+compile "org.mini2Dx:gdx-xml:1.9.8"
+```
+
+This project's only dependency is [gdx-collections](https://github.com/mini2Dx/gdx-collections).
+
+Included Classes
+----------------------
+
+ * BufferUtils.java
+ * SerializationException.java
+ * StreamUtils
+ * XmlReader
+ * XmlWriter