summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
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`