From 10dd9fb3cf0a4836e3a4bf9e10b47f234e80f8ee Mon Sep 17 00:00:00 2001 From: Cesium Date: Sun, 9 Nov 2025 19:46:42 -0500 Subject: [PATCH] slightly better readme --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 53183c1..e404fe8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,65 @@ # goofy discord torn bot -## usage +this is mainly linux instruction, you can install WSL if you wanna do this on windows, +should work the same, i dont know how docker works on mac so good luck i guess + +
+ +Docker + +you need `git`, `docker`, and `docker-compose` + +## setup + +clone the repo with `git clone https://github.com/CesiumCs/tornbot.git` edit `default.config.json` into `config.json` copy `docker-compose.yml.default` to `docker.compose.yml` and tweak if needed -if you have docker set up already, it should be good to spin up `docker-compose up -d`, -which should handle dependencies and all that \ No newline at end of file +spin it up `docker-compose up -d`, which should handle dependencies and building the container and all that + +## updating + +pull changes with `git pull` + +bring the container down with `docker-compose down` and spin it up with `docker-compose up --build -d` to rebuild the container +(i usually run `git pull && docker-compose down && docker-compose up --build -d` to do all that in one command) + +## registering commands + +this doesnt register its commands with discord by default + +while the container is running, exec `node deploy-commands.js` inside of it: like `docker exec -t tornbot_bot_1 node deploy-commands.js` + +
+ +
+ +not Docker + +you need `git`, `node`, and `npm` + +## setup + +clone the repo with `git clone https://github.com/CesiumCs/tornbot.git` + +edit `default.config.json` into `config.json` + +install dependencies with `npm i` + +run with `node index.js` + +## updating + +pull changes with `git pull` + +restarting will apply updates + +## registering commands + +this doesnt register its commands with discord by default + +run `node deploy-commands.js` + +