aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAda Isopods <me@bathynomus.xyz>2024-04-03 01:41:15 -0600
committerAda Isopods <me@bathynomus.xyz>2026-10-21 23:27:37 -0600
commit82939c664fcd079a6a1726ac17e6df456eb14423 (patch)
treeab2dd4013a157a204cc1aae9e2d4828e4613d06b /README.md
parentf3b8839feab4f8406fece1d350fb72a3b38bdb5f (diff)
Add the code
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index d6e063b..b642298 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
-# key-emojipack-generator
+Janky Python script to generate the requisite meta.json file to make an emoji pack that can be imported by a *key instance.
-Procedurally generate a meta.json file for importing a folder of emojis on a *key instance \ No newline at end of file
+# Usage
+
+Provide the script with a directory and it will generate a meta.json file listing every PNG/JPG/GIF/WEBP file, extrapolating the emoji name from the filename, and the category name from the directory name.
+
+- Pass `--host` to optionally customize the hostname used as the `host` property.
+- Pass `-p` to print the JSON to stdout instead of saving it. \ No newline at end of file