diff --git a/README.md b/README.md index 93d4e0d..09b35d8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ #### node.js IRC bot framework -Bones is the base framework I use for creating multithreaded IRC bots, originally developed as a way to hugely improve on the speeds of earlier versions of mercury (which were not multithreaded and was very slow) +Bones is the base framework I use for creating multithreaded IRC bots, originally developed as a way to hugely improve on the speeds of earlier versions of mercury which was at one point extraordinarily slow. + +Bones will open all called bot commands in their own node process and then feed back the output as a string to the main file in order to be sent to IRC. This way the main process effectively only acts as a handler for prompts, forcing all outputs to be generated in seperate processes means the bot operates much faster than if the entire thing was just in the main bot.js file. ## Deployment @@ -13,6 +15,11 @@ Instructions are general and assume you have already developed something with th 3. You may also want to edit the container names in the `docker-compose.yml` file accordingly. (Optional but recommended) 4. Run `docker compose up` to begin. Append `-d` to start in the background and `--build` for the first run and subsequent starts after edits have been made. If you begin the bot with `-d` you can run `docker compose logs -f` to see live logs. +## Examples + +- mercury (https://git.supernets.org/hgw/mercury) +- fascinus (https://git.supernets.org/hgw/fascinus) + ## Support If you need assistance with installation or usage, you are more than welcome to contact me in #5000 on `irc.supernets.org`