From 06b1de707b7bae583a1bab6217c43f33f88ef58a Mon Sep 17 00:00:00 2001
From: yellows111 <yellows111@cirno.darkok.xyz>
Date: Thu, 12 Oct 2023 08:51:53 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd9abc8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# icondumper2 (working title)
+A JavaScript library (sorta) to read PS2 icons, and their related formats.
+
+## What it supports
+* EMS Memory Adapter export files (.psu)
+* PS2 icons (.ico, .icn)
+* PS2D format (icon.sys) 
+
+## What can it do
+* Allow any file in a PSU's virtual filesystem to be dumped.
+* Warn of invalid icon.sys titles.
+* Read and parse an EMS MA export file.
+* Export the icon model, with all seperate shapes included to a JavaScript Object.
+* Node.js compatible (CommonJS) exporting while still being compatible with other JavaScript implementations.
+
+## What it doesn't do
+* (Re)build save files.
+* Modify the original input files.
+* Use any Node.js-exclusive features.
+
+## Client compatibility
+(todo: write this)
+
+## Why "icondumper2"?
+Because it replaced what *was* left of icondumper.