From e6e522948447e2b4476d3c8d85a07910f2e8f5cb Mon Sep 17 00:00:00 2001
From: Luzifix <luzifix19@gmail.com>
Date: Fri, 2 Aug 2024 01:19:37 +0200
Subject: [PATCH] Add readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..073266d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# ADTMeta
+Automatically dumps Texture and GroundEffect metadata from World of Warcraft ADT files into a JSON format and saves it to the [Meta](Meta) folder.
+
+## Generated Metadata
+### Retail
+#### Texture
+- [Texture info by texture file id](Meta/wow/Texture/TextureInfoByTextureFileID.json)
+- [Texture info by texture file path](Meta/wow/Texture/TextureInfoByTextureFilePath.json)
+
+#### GroundEffects
+- [GroundEffects by texture file id](Meta/wow/GroundEffect/GroundEffectByTextureFileID.json)
+- [GroundEffects by texture file path](Meta/wow/GroundEffect/GroundEffectByTextureFilePath.json)
+
+## Usage
+Arguments: `ADTMeta.exe <product> (metaFolder)`  
+