Adding some of the creator's original readme

README.md

@@ -1,2 +1,33 @@
-# neomouse
+# Neomouse
 
+⚠️ There are mice ⚠️
+
+version 1.2
+
+## Installation
+### Pleroma and Akkoma
+
+    Currently you need to manually import the zip files with adminFE because i am lazy uhm if you know how this works contact me. smile
+
+### -key based
+
+    Use the three dots menu to upload the two zip files in the custom emojis manager
+
+### Mastodon
+
+    Make a tar.gz archive of the emojis and import them with the Admin CLI
+
+
+#### conversions
+
+uhhm this is here for (my own) future reference.. for some reason the emoji-gen --help doesnt mention you need a --group flag.. whoops!
+
+(do all of these inside a folder with all of the files to convert)
+
+svg > png
+
+    $ find -name "*.svg" -exec sh -c 'inkscape $1 --export-height=256 --export-png=${1%.svg}.png' _ {} \;
+
+create pack
+
+    $ emoji-gen local --group SOMETHING --folder .