From ad39cf856667dd000d18ca20f53c5c16d549d01d Mon Sep 17 00:00:00 2001 From: hgw Date: Mon, 2 Oct 2023 02:14:36 +0000 Subject: [PATCH] Update README --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a9dc3ba..26e9078 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,32 @@ cold hard bot for cold hard chats - $uspam [LINES] - Spams x lines of random unicode characters of varying length. - $art [IMAGE URL (png/jpg)] - Creates IRC art using a source image. +## 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 + ## Credits -- [phy1729/banter](https://github.com/phy1729/banter) - $art uses a version of banter modified to allow URLs in place of local image files. These changes will be published upstream once refined. \ No newline at end of file +- [phy1729/banter](https://github.com/phy1729/banter) - $art uses a version of banter modified to allow URLs in place of local image files. These changes will be published upstream once refined. + +## License + +ISC License + +Copyright (c) 2023 hogwart7 + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. + +This repository contains a modified version of banter (https://github.com/phy1729/banter) which is licensed under GNU-GPL v3.0 \ No newline at end of file