summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormsglm <msglm@techchud.xyz>2023-01-17 07:02:01 -0600
committermsglm <msglm@techchud.xyz>2023-01-17 07:02:01 -0600
commita8552bb41eb7115a028b2e841826ca6c5c1a8fda (patch)
tree38b446d5c3b2dfae11add1c1ac93334e0a071f07
parent912b4900f3a03ab280b64bb3f63c3b236901dfcd (diff)
downloadswinIR_API-a8552bb41eb7115a028b2e841826ca6c5c1a8fda.tar.gz
swinIR_API-a8552bb41eb7115a028b2e841826ca6c5c1a8fda.tar.bz2
swinIR_API-a8552bb41eb7115a028b2e841826ca6c5c1a8fda.zip
better documentationHEADv1.0.0master
-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`