Merge pull request #7 from sam123114/6-write-readme-for-the-project

[6] Write README for the project

README.md

@@ -1,3 +1,56 @@
 # LolQuizz
 
-This is a project I made for fun. If you have any suggestions or want to update it youself, you can create a issue or a pull request.
+LolQuizz is a project created with the goal of creating a Discord bot that will provide mini-games as well as fun and useful commands related to the league of legends game and it's lore.
+
+## Prerequisites
+
+- Git
+- Node.js
+
+## Installation
+
+Clone the project locally
+
+- using `HTTPS`
+
+  ```bash
+  git clone https://github.com/sam123114/LolQuizz.git
+  ```
+
+- using `SSH`
+
+  ```bash
+  git clone git@github.com:sam123114/LolQuizz.git
+  ```
+
+Head into the `LolQuizz` folder
+
+  ```bash
+  cd LolQuizz/
+  ```
+
+Install the dependencies
+
+  ```bash
+  npm install
+  ```
+
+Create `.env` file
+
+  ```text
+  DISCORD_TOKEN="{YOUR_DISCORD_TOKEN}"
+  ```
+
+You can now start the bot by using one of those commands:
+
+- Development (Using [nodemon](https://www.npmjs.com/package/nodemon))
+
+  ```bash
+  npm run dev
+  ```
+
+- Production
+
+  ```bash
+  npm run stable
+  ```