From b3f2ebb4741fba4204e588cbcf19345a5fff2c0a Mon Sep 17 00:00:00 2001
From: Natty <natty.sh.git@gmail.com>
Date: Sat, 30 Sep 2023 18:22:19 +0200
Subject: [PATCH] Added a README

---
 README.md | 25 +++++++++++++++++++++++++
 main.py   |  2 +-
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef1ca14
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# matrix-emoji-upload
+
+Automated emoji uploader for Matrix.
+
+Very janky and without any guarantees.
+
+## Usage
+
+Install dependencies:
+
+`pip -r requirements.txt`
+
+Run as a CLI command:
+
+```
+python emoji-upload [-h] --tag TAG --token TOKEN --instance INSTANCE emoji_file [emoji_file ...]
+
+positional arguments:
+  emoji_file           a list of files to upload
+
+options:
+  --tag TAG            the Matrix handle of the user
+  --token TOKEN        a Matrix account bearer token
+  --instance INSTANCE  a Matrix instance domain
+```
\ No newline at end of file
diff --git a/main.py b/main.py
index 9d59a57..81e7fcf 100644
--- a/main.py
+++ b/main.py
@@ -103,7 +103,7 @@ if __name__ == "__main__":
         description="Batch upload emojis to Matrix")
 
     parser.add_argument("files",
-                        metavar="F",
+                        metavar="emoji_file",
                         type=str,
                         nargs="+",
                         help="a list of files to upload")