Pretty much full re-write, switched from node-irc to irc-framework, fixed some bugs, imrpoved some stuff, changed config from XML to yaml.

README.md

@@ -1,18 +1,69 @@
 # Discord-userbot-to-irc
 A crappy group chat to a IRC room bridge written in node </3
 
+## Features:
+- Multi-Bridge Support - You can bridge multiple channels with multiple IRC rooms all with one config.
+- Reactions Bridging - When a user reacts to a Discord message, the bridge sends a notification to IRC :D
+- Attachments Bridging - Automatically forwards links to images and attachments from Discord messages to IRC
+- TLS/Non-TLS IRC Support - Works with both secure (TLS) and standard IRC ports.
+- Group chat bridges - Since this all works with a selfbot it means that you can bridge a Discord group chat to a IRC room.
+- YAML Configuration - Simple and a human readable config.
+
+
 # What you need to run this:
+
+- Node.js v18+  
+- `npm` package manager
+
 ```
 Dependecies:
-xml2js
-discord.js-selfbot-v13
-irc
+    "discord.js-selfbot-v13": "^2.10.0",
+    "irc-framework": "^3.0.0",
+    "yaml": "^2.3.1"
 ```
-### You also need a discord user token.
 
-Before you run it edit the example.config.xml file with all the correct informatiion and rename it to config.xml
+## Before running:
+What you gonna need:
+
+- A Discord user or bot token.
+- An IRC room.
+- Discord group/channel ID
+- A server or machine to run the bot on.
+
+## Installation
+1. Clone the repository:
+
+```bash
+git clone https://foundry.fsky.io/purplebored/Discord-userbot-to-irc.git
+cd Discord-userbot-to-irc
+```
+
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Configuration:
+
+Rename the `example.config.yaml` file to config.yaml and set it up to your liking.
+
+## Config:
+You can easaily enable or disable the logging of messeges or the raw IRC info for debuging by switching `debug: false` to `debug: true`, and the same with `logForward`
+
+## How to run it:
+Just run:
 
-## To run it just run:
 ```
 node bot.js
 ```
+
+## Notes:
+
+- Make sure your Discord selfbot token is kept private.
+- For secure IRC connections, ensure `tls: true` and correct port
+
+# Warning:
+I would not reccomend using this in a active room since that might get the bot/userbot rate limited which is not good ! 
+
+Also Using Userbots is against Discord's Terms of Service so your account/bot might get deactived. This has not happen yet but it is still possible.