Add: a new Contributing.md file, Update: the readme and license

This commit is contained in:
2025-09-21 20:30:26 +02:00
parent 64d90f92c2
commit a7f19fbb4f
4 changed files with 256 additions and 6 deletions

View File

@@ -10,6 +10,22 @@ A crappy group chat to a IRC room bridge written in node </3
- YAML Configuration - Simple and a human readable config.
# Warning:
I would not reccomend using this in a active room since that might get the bot/userbot rate limited on Discord OR IRC 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.
Also worth to mention. Discord nicknames only show up if you bridge a channel, in group chats the bridge will use the user's username and I don't think there is anything I can do about that.
## Features to be added:
- Webhooks for briding channels
- A docker compose file
- More options in the config.
- Relay MSG on the IRC side.
- Being able to configure the bot with commands instead of needing to config the commands.
- Storing debug logs and messege logs in a txt file.
# What you need to run this:
- Node.js v18+