Update README

master
GreenDimond 2019-11-09 19:51:43 -08:00
parent b0e866fd4c
commit 67d75a380a
1 changed files with 13 additions and 2 deletions

View File

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