From 8bbade7409544361774b596cf2639152aff091d6 Mon Sep 17 00:00:00 2001
From: msglm <msglm@techchud.xyz>
Date: Sun, 17 Aug 2025 19:54:47 -0500
Subject: better documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6ca795
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# swinIR_API
+Allows you to send images to https://huggingface.co/spaces/akhaliq/SwinIR to be upscaled via the cli.
+
+# Usage
+`swinIR_API $FILE_NAME` where $FILE_NAME is the file you wish to upscale.
+
+# Building
+`nim c swinIR_API.nim`
-- 
cgit v1.2.3