Added a README

This commit is contained in:
Natty 2023-09-30 18:22:19 +02:00
parent d6adfe8848
commit b3f2ebb474
Signed by: natty
GPG Key ID: BF6CB659ADEE60EC
2 changed files with 26 additions and 1 deletions

25
README.md Normal file
View File

@ -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
```

View File

@ -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")