benkyd/JefferyBot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ben
2018-06-18 20:50:59 +01:00
committed by GitHub
parent ceedb3b277
commit d92e2fc22c
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,3 +1,25 @@
# JefferyBot
An open source, customizable discord bot, made with the discord.js framework.
## Discord
[![JS-D-BOT Server](https://discordapp.com/api/guilds/424116223362465794/widget.png?style=banner2)](https://discord.gg/782zeM9)
The official JefferyBot server with the master version of Jeffery running live
## Installation
To run JefferyBot, first you must install node. Then run cd to the install directory, then run `npm install` and all of Jeffery's dependencies will automatically install. The first time you run Jeffery it wil instantly exit, a configuration file will be created in the resources folder, a child to the root directory.
In config.json you must put your bot's token, and the rest is self explanitory.
Once you have set up the config file, run `node main.js` inside the JefferyBot directory and Jeffery will be running. Then in discord, in a server that your copy of Jeffery is in you can run +help for an extensive list of commands.
## License
MIT
## Contrubuters
- Ben (plane000)#8618 - Creator, maintaner