From 1cfc4a8fa8aa8a5f8a820903c4da6c87f9694171 Mon Sep 17 00:00:00 2001
From: Superkooka <aymeric.gueracague@gmail.com>
Date: Thu, 30 Jun 2022 14:01:52 +0200
Subject: [PATCH] :memo: setup instruction on README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index e69de29..5f42cab 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,16 @@
+# Discord Dropdown POC
+
+A POC of a Discord bot using the dropdown capability
+
+## How to install
+
+1. Clone the repo
+2. Clone the config.exemple.toml and rename it config.toml
+3. Launch the docker container with `make start` or `docker-compose up`
+4. Go into the docker container with `make shell` or `docker-compose exec discord-bot bash`
+5. Install the dependencies: `yarn`
+6. Compile typescript and run the bot with `yarn dev` 
+
+## Contributions/License
+
+This project has an AGPLv3 license. This project use the `Sheweny` framework with `discord.js` underlying and `BinaryMuse/toml-node` for configuration parsing.