From ec4f20a5ed8e64bf3584d78ad3f723a388530755 Mon Sep 17 00:00:00 2001
From: Mikkeli Matlock <matlockib@gmail.com>
Date: Wed, 26 Aug 2026 15:37:52 +0900
Subject: [PATCH] chore: modified README and added Reqs

---
 README.md       | 4 +---
 REQUIREMENTS.md | 6 ++++++
 2 files changed, 7 insertions(+), 3 deletions(-)
 create mode 100644 REQUIREMENTS.md

diff --git a/README.md b/README.md
index 8f12c30..a6f36fe 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,4 @@ Generates SVG QR codes from any text input.
 
 ```
 python qr.py <TEXT> -o <OUTPUT_PATH>
-```
-
-## notice
\ No newline at end of file
+```
\ No newline at end of file
diff --git a/REQUIREMENTS.md b/REQUIREMENTS.md
new file mode 100644
index 0000000..fc86fc6
--- /dev/null
+++ b/REQUIREMENTS.md
@@ -0,0 +1,6 @@
+# Reqs
+
+## cli options (args)
+- **raw text mode**: `-t <TEXT>` or `-t "<TEXT>"` (for those including space/tabs); `-t` can be omitted as this is the default mode.
+- **output path**: `-o PATH/TO/SVG`. Automatically append `.svg` suffix if absent. When whole option is absent, use input text but path-incompatible characters substituted with `_`, and filename capped at 32 chars.
+- **batch mode**: `-i <FILE_OF_LINES_TO_CONVERT>` ; output automatically dumps generated svgs per line of input file under `output/`; SVG files named after input lines verbatim except that path-incompatible characters substituted with `_` (underbar), and filename capped at 32 chars. Disregard `-o`.