hgw/mercury
hgw
/
mercury
1
Fork 0
Code Issues Pull Requests Packages Wiki Activity

update readme

This commit is contained in:
hgw 2023-10-02 02:11:25 +00:00
parent d2d896667c
commit fbd3505e3c
1 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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.
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.