Simple & Customisable RSS Client for IRC

cold-hard-chats fuck-your-network irc irc-bot rss

Go to file

hgw 422825d850 update readme		2023-10-02 02:11:24 +00:00
commands	init	2023-10-02 02:11:23 +00:00
config	init	2023-10-02 02:11:23 +00:00
.dockerignore	new readme and dockerignore	2023-10-02 02:11:24 +00:00
.gitignore	init	2023-10-02 02:11:23 +00:00
bot.js	change prefix to m!	2023-10-02 02:11:24 +00:00
docker-compose.yml	init	2023-10-02 02:11:23 +00:00
Dockerfile	init	2023-10-02 02:11:23 +00:00
LICENSE	init	2023-10-02 02:11:23 +00:00
package-lock.json	init	2023-10-02 02:11:23 +00:00
package.json	init	2023-10-02 02:11:23 +00:00
README.md	update readme	2023-10-02 02:11:24 +00:00

README.md

Mercury

RSS Parser for IRC

Commands

m!set [OPTION] [VALUE] - Changes a bot setting, more info to be added here later.

Deployment

Install Docker (required) and Docker Compose (optional, but strongly recommended)
Rename config/example.default.json to config/default.json and modify it accordingly.
Run docker compose up to begin. Append -d to start in the background and --build if you make any changes to any files.

Support

If you need assistance with installation or usage, join #5000 on irc.supernets.org

License

ISC License

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.