Fix: I fixed some of the spelling mistakes to make the readme file better.

This commit is contained in:
2025-09-24 12:37:26 +02:00
parent 1a7f3a413d
commit 6ac41d3215

View File

@@ -12,9 +12,9 @@ A crappy group chat to a IRC room bridge written in node </3
# 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 !
I would not recommend 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 Using Userbots is against Discord's Terms of Service so your account/bot might get deactivated. 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.
@@ -25,7 +25,7 @@ Also worth to mention. Discord nicknames only show up if you bridge a channel, i
- 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.
- Storing debug logs and message logs in a txt file.
# What you need to run this:
@@ -92,7 +92,7 @@ docker run -d -v "$(pwd)/config.yaml:/app/config.yaml:ro" foundry.fsky.io/purple
The /app/config.yaml file in the container must be mounted to the filesystem.
## 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`
You can easaily enable or disable the logging of messages or the raw IRC info for debugging by switching `debug: false` to `debug: true`, and the same with `logForward`
## Notes: