From 67d75a380a8647af5606716caf0d5b108af440fd Mon Sep 17 00:00:00 2001 From: GreenDimond <24834740+GreenXenith@users.noreply.github.com> Date: Sat, 9 Nov 2019 19:51:43 -0800 Subject: [PATCH] Update README --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8391d34..001903a 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,21 @@ _MinetestBot and it's author(s) are in no way affiliated with the IRC MinetestBo Uses NodeJS and `discord.js`. -To use the bot, run `node .` in the bot directory. +## Installation ## + +``` +git clone https://github.com/GreenXenith/minetestbot.git +cd minetestbot +npm install +``` MinetestBot demands a ~~sacrifice~~ `config.json`. See `config.json.example`. +## Usage ## + +To use the bot, run `node .` in the bot directory. +I recommend you use a cron job or systemd service + ### Todo (PRs welcome) ### * Better CDB search * ~~Vote starter~~ @@ -15,6 +26,6 @@ MinetestBot demands a ~~sacrifice~~ `config.json`. See `config.json.example`. * Word definition * Forum search -Might be missing `;` everywhere. +Might be missing `;` everywhere, or have too many. This used to be written in Lua, but Luvit is garbage.