Add README.md

README.md

@@ -0,0 +1,89 @@
+# Cyber Verified - Emote Pack
+![](https://emotes.cc/img/previews/revengeday_cyberverified.png)
+### [💾 Download Emote Pack](https://git.cyberwa.re/revengeday/cyber-verified-emotes/releases)
+
+## Installation
+
+**Note to Users**: This documentation is aimed at admins of Fediverse instances. If you're not an admin, feel free to send this page to your instance admin and let them know that you'd like to see more emotes on the instance - your wish might just come true!
+  
+This documentation provides detailed steps to upload emote packs to various Fediverse instances including Mastodon, Akkoma, Misskey and Pleroma. Follow the outlined instructions specific to your instance below.  
+  
+## Pleroma and Akkoma  
+  
+### Requirements:  
+  
+- Command line access to your instance.  
+  
+### Steps:  
+  
+1. Run the following command:  
+```bash  
+mix pleroma.emoji get-packs  
+```  
+This command will fetch and install the emote packs available for Pleroma and Akkoma.  
+  
+## Misskey, Iceshrimp, FlamingoKey, and Other Misskey-based Instances  
+  
+### Requirements:  
+  
+- Administrative access to the control panel of your instance.  
+  
+### Steps:  
+  
+1. **Navigate to the Emoji Section:**  
+- Login to your instance’s control panel.  
+- Go to the 'Emoji' section.  
+  
+2. **Import Emote Pack:**  
+- Open the three-dot menu in the emoji section.  
+- Select the “Import” option.  
+  
+3. **Choose the Emote Pack to Import:**  
+- Download the latest `.zip` archive of the emote pack you wish to import.  
+- Use the "Import" option to upload the .zip file.  
+  
+The emojis within the pack will be categorized automatically.  
+  
+## Additional Notes for Misskey and Its Forks (Iceshrimp, WhizzyFizzyKey, Forkkey, Kittykey, YetAnotherMisskeyForkKey etc.)  
+  
+### Meta.json Utilization:  
+  
+Many PNG archives come with a `meta.json` file that can be utilized for importation.  
+  
+### Steps:  
+  
+1. **Download the Emote Pack Archive:**  
+- Obtain the latest `.zip` archive for the pack you want to import.  
+  
+2. **Import via the Control Panel:**  
+- Go to the 'Custom Emoji' area in your administrative control panel.  
+- Use the option to import the `.zip` file.  
+  
+The emojis should automatically be categorized as per the `meta.json` file included in the archive.  
+  
+## Mastodon and Glitch-soc  
+  
+### Requirements:  
+  
+- Command line access to your instance.  
+- `tootctl` CLI tool available on your instance.  
+  
+### Steps:  
+  
+1. **Download the Emote Pack Archive:**  
+- Download the `.tar.gz` archive of the emote pack you wish to use.  
+- If you are comfortable with running shell commands, you can do this directly from the instance's live directory:  
+```bash  
+wget GITURL PACK_NAME.tar.gz  
+```  
+  
+2. **Run the tootctl Import Command:**  
+```bash  
+RAILS_ENV=production bin/tootctl emoji import --category PACK_NAME ./PACK_NAME.tar.gz  
+```  
+Replace `PACK_NAME` with the actual name of the pack (e.g., fromcorteximplantwithlove, prideletters).  
+  
+3. **Alternatively, If You Have Pre-Downloaded the Archive:**  
+```bash  
+RAILS_ENV=production bin/tootctl emoji import --category PACK_NAME /path/to/PACK_NAME.tar.gz  
+```