From 31bbc3bb93122d532882948a164c2b2c66465001 Mon Sep 17 00:00:00 2001
From: Vegard Bieker Matthey <VegardMatthey@protonmail.com>
Date: Fri, 17 Jul 2026 23:27:20 +0200
Subject: [PATCH] add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be04cd0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# ImageViewer
+The simple manga reader that is metadata aware.
+
+## Usage
+> [!WARNING]
+> This app can take a long time to start after adding new manga because of metadata generation.
+
+Create a folder for the manga and create a folder inside called volumes. Place your CBZ files inside volumes. 
+
+> [!NOTE]
+> The app does not regenerate the metadata file if it already exists, even if there are new volumes.
+
+When you first start the app, it will create a flatbuffer binary file with the metadata is has extracted from the entries in the zip.
+
+You can modify this file yourself if you want. I recommend converting to JSON, modifying it with a text editor, and the converting back.
+
+To convert the metadata file to JSON you can run a command similar to this:
+```sh
+flatc --json --defaults-json --raw-binary metadata.fbs -- metadata.fb
+```
+
+To convert back to binary you can run a command like this:
+```
+flatc --binary metadata.fbs metadata.json
+```
+
+Why do this?
+To set metadata that is not found in the filename such as chapter name, volume name and other things such as release date.