diff --git a/README.md b/README.md index 0d45893..53d16c1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # Luca + Luca is the best bot you'll need for managing and informing members of the server + +## Requirements + +- [Node](https://nodejs.org/en/) +- [NPM](https://www.npmjs.com/) + +## Getting started + +First, make sure you have all the required tools installed on your local machine then continue with these steps. + +### Installation + +```bash +# Clone the repository +git clone https://github.com/top-gg/Luca.git + +# Enter into the directory +cd Luca/ + +# Install the dependencies +npm install +``` + +### Configuration + +After cloning the project and installing all dependencies, you need to add your Discord API token in the bot.js file at line 319 and 321. + +### Starting the application + +```bash +node bot.js +```