From 5ee308dc05cdc400a983687adee49d8c75680682 Mon Sep 17 00:00:00 2001 From: hgw Date: Mon, 2 Oct 2023 02:11:24 +0000 Subject: [PATCH] new readme and dockerignore --- .dockerignore | 4 +++- README.md | 16 +++++----------- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/.dockerignore b/.dockerignore index 84542de..b72dd74 100644 --- a/.dockerignore +++ b/.dockerignore @@ -5,4 +5,6 @@ Dockerfile docker-compose.yml scratch config/example.default.json -config/default.json \ No newline at end of file +config/default.json +LICENSE +README.md \ No newline at end of file diff --git a/README.md b/README.md index 8512376..5c30677 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,16 @@ -# Fascinus (fa-see-nus) +# Mercury -cold hard bot for cold hard chats +RSS Parser for IRC ## Commands -- $flood [AMOUNT] [TEXT] - Floods the channel with a specific line x amount of times -- $ctcpflood [TARGET] [TEXT (one word)] [AMOUNT] - Sends x amount of CTCP requests to a target. -- $sneed - Pastes the Sneed's Feed and Seed copypasta. -- $rspam [LINES (def=100, max=100000)] - Spams x lines of random characters. -- $uspam [LINES (def=100, max=100000)] - Spams x lines of random unicode characters of varying length. -- $art [IMAGE URL (png/jpg)] - Creates IRC art using a source image. -- $godwords [AMOUNT (def=50, max=100000)] - Generate x amount of random words. Inspired by TempleOS. +- m!set [OPTION] [VALUE] - Changes a bot setting, more info to be added here later. ## Deployment 1. Install Docker (required) and Docker Compose (optional, but strongly recommended) -2. Modify the info in the config block in `bot.js` to your taste. -3. Run `docker compose up` to begin. Append `-d` to start in the background and `--build` if you make any changes to any files +2. Rename `config/example.default.json` to `config/default.json` and modify it accordingly. +3. Run `docker compose up` to begin. Append `-d` to start in the background and `--build` if you make any changes to any files. ## Support