Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
e-enes authored Mar 25, 2023
1 parent cdf9664 commit 7ac6156
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This is a Discord bot that tracks invitations for your server. You can view the leaderboard to see which members have invited the most people, reset a member's invitation count, and more.

*Currently only supports one guild per bot and requires a MySQL database*
*Currently only supports one guild per bot and requires a MySQL database, Discord.js v14.8.0*
## Requirements
* Node.js +16.x.x
* MySQL Server
Expand Down Expand Up @@ -34,12 +34,23 @@ USER=
PASSWORD=
DATABASE=
```
4. Start the bot:
4. Configure the `'config.ts'` file with these informations:
```js
export default {
channel: {
welcome: "id channel",
leave: "id channel",
log: "id channel"
}
}
```
5. Start the bot:
```
$ tsc
$ cd dist
$ node index
```
_Make sure to manually import the .env file into the dist folder_
## Features
* Track invites of each server member
* View the invite leaderboard
Expand Down

0 comments on commit 7ac6156

Please # to comment.