From 005f73578977d30b3a869fc45efeb575c90b4afb Mon Sep 17 00:00:00 2001 From: Vylpes Date: Mon, 9 Nov 2020 10:18:14 +0000 Subject: [PATCH] Add readme.md --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 43 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5b3473a..0219f70 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# vylbot-app \ No newline at end of file +# VylBot App + +Discord bot for Vylpes' Den Discord Server. Based on [VylBot Core](https://github.com/getgravitysoft/vylbot-core). + +## Installation + +Download the latest version from the [releases page](https://github.com/Vylpes/vylbot-app/releases). + +Copy the config template file and fill in the strings. + +```json +{ + "token": "", + "prefix": "v!", + "commands": [ + "essentials/commands", + "commands" + ], + "events": [ + "events" + ] +} +``` + +* **Token:** Your bot's token +* **Prefix** The command prefix +* **Commands:** An array of the folders which contain your commands +* **Events:** An array of the folders which contain your events + +## Usage + +Implement the client using something like: + +```js +const vylbot = require('vylbot-core'); +const config = require('./config.json'); + +const client = new vylbot.client(config); +client.start(); +``` + +See the `docs` folder for more information on how to use vylbot-core \ No newline at end of file diff --git a/package.json b/package.json index 01f40f0..c90f6dd 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "vylbot-app", "version": "1.0.0", "description": "", - "main": "bot.js", + "main": "vylbot.js", "scripts": { "start": "node vylbot.js", "test": "echo \"No tests specified\""