From fbd3505e3c949e953f71cdf31ab46ea46482afce Mon Sep 17 00:00:00 2001 From: hgw Date: Mon, 2 Oct 2023 02:11:25 +0000 Subject: [PATCH] update readme --- README.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e384aef..ec339b3 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ This bot is not completed, expect bugs/crashes/errors. Use in production is disa ## Deployment -1. Install Docker (required) and Docker Compose (optional, but strongly recommended) -2. Rename `config/example.default.json` to `config/default.json` and modify it accordingly. +1. Install Docker (required) and Docker Compose (optional, but strongly recommended, this guide assumes you have it) +2. Rename `config/example.default.json` to `config/default.json` and modify it accordingly. A list of variables and their descriptions can be found in this repos wiki. 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 @@ -23,18 +23,8 @@ If you need assistance with installation or usage, join #5000 on `irc.supernets. ## License -ISC License +This software is licensed under the ISC License, its full text can be found [here](/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. \ No newline at end of file +Some required packages may be using licenses other than the ISC License. A full +list of packages can be found in `package-lock.json` and their licenses can be +found on their respective homepages/repositories. \ No newline at end of file