Skip to content

Commit

Permalink
📝 Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
antoinemcx committed Mar 3, 2023
1 parent aa6d1b7 commit d4a1035
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Structure-Discord-Bot [![Stars](https://img.shields.io/github/stars/meliooff/Structure-Discord-Bot)](https://github.com/meliooff/Structure-Discord-Bot) [![Codefactor](https://www.codefactor.io/Content/badges/APlus.svg)](https://www.codefactor.io/repository/github/meliooff/structure-discord-bot)
# Structure-Discord-Bot [![Stars](https://img.shields.io/github/stars/antoinemcx/Structure-Discord-Bot)](https://github.com/antoinemcx/Structure-Discord-Bot) [![Codefactor](https://www.codefactor.io/Content/badges/APlus.svg)](https://www.codefactor.io/repository/github/antoinemcx/structure-discord-bot)

Command, slash command & event handler by [Mélioᴼᶠᶠ](https://github.com/meliooff) - Bot Discord (v13.X.X)
Command, slash command & event handler by [Melio](https://github.com/antoinemcx) - Bot Discord (v14.X.X)
Moreover, the command and slash commands handlers contain a permissions checker and a cooldown checker ;
For better referencing, please add a star on the repository


# Configuration
## Setup the project

The configuration file named **config.js** have to content the token of your discord bot, its prefix and the IDs of all other owners (or just yours).
The configuration file named **config.js** have to content yout bot's token and prefix, and the IDs of all other owners (or just yours).
```js
module.exports = {
token: 'THE_BOT_TOKEN',
Expand All @@ -16,31 +16,32 @@ module.exports = {
owner: [ "YOUR_DISCORD_ID" ],
};
```
ᅠᅠ

# Commands
### Installation

**Installation**
> `npm install`
```sh
$ npm install
```

**Register slash commands**
> `node slash.js`
### Register slash commands

**Start the bot**
> `node index.js`
```sh
$ npm run slash
```

# Errors
### Start the bot

For any errors found, please contact me [here](https://discord.com/invite/G6WQsMQShZ) for exemple or do a pull request.
```sh
$ npm run start
```

## More

# License
This repository is licensed under the MIT License. See the `LICENSE` file ([here](https://github.com/meliooff/Structure-Discord-Bot/blob/master/LICENSE)) for more information.
ᅠᅠ
For any errors found, please contact me [here](https://discord.com/invite/G6WQsMQShZ) for exemple or do a pull request.

### License
This repository is licensed under the MIT License. See the `LICENSE` file ([here](https://github.com/antoinemcx/Structure-Discord-Bot/blob/master/LICENSE)) for more information.

# Table of contents
* [Introduction](#Structure-Discord-Bot)
* [Configuration](#Configuration)
* [Commands](#Commands)
* [Errors](#Errors)
* [License](#License)

###### Made with ❤️ by [meliooff](https://github.com/antoinemcx) in JavaScript.

0 comments on commit d4a1035

Please sign in to comment.