proper readme

README.md

@@ -1,21 +1,49 @@
-# FLOPOBOT DEUXIEME DU NOM
+# FlopoBot
 
-## Project structure
+**FlopoBot** is a Discord bot built with Node.js and discord.js. It is the succesor to the original Python-based FlopoBot, featuring a modernized codebase and Slash Command support.
 
-Below is a basic overview of the project structure:
+## Project Structure
 
 ```
-├── .env.sample
+├── public/
-├── index.js      -> main entrypoint for app
+│   └── images/               # Static assets
-├── commands.js -> slash command payloads + helpers
+├── src/              
-├── game.js     -> some stuff and data
+│   ├── api/                  # External API integrations
-├── utils.js    -> utility functions and enums
+│   ├── bot/                  
-├── package.json
+│   │   ├── commands/         # Slash command implementations
-├── README.md
+│   │   ├── components/       # Discord message components
-└── .gitignore
+│   │   ├── handlers/         # Event handlers
+│   │   ├── client.js         # Discord client setup
+│   │   └── events.js         # Event registration
+│   ├── config/
+│   │   └── commands.js       # Slash command definitions
+│   ├── database/ 
+│   │   └── index.js          # Database connection and models
+│   ├── game/                 # Game logic and data
+│   ├── server/       
+│   │   ├── routes/           # Express routes
+│   │   ├── app.js            # Express app setup
+│   │   └── socket.js         # Socket.io setup
+│   └── utils/                # Utility functions
+├── commands.js               # Slash command registration and definitions
+└── index.js                  # Main entry point for the bot
 ```
 
-## FlopoSite
+## Features
+- **Moderation Tools** : Includes commands for managing server members.
+- **AI Integration** : Utilizes AI APIs for enhanced interactions.
+- **Game Mechanics** : Implements game features and logic.
+- **Slash Commands** : Fully integrated with Discord's slash command system (defined in `config/commands.js` and implemented in `bot/commands/`).
+- **Modular Architecture** : Logic is separated into the `src/` directory for better maintainability.
+- **Web Integration** : Designed to work alongside a [FlopoSite](https://floposite.com) (see [FlopoSite's repo)](https://github.com/cassoule/floposite)).
 
-- FlopoBot has its own website to use it a different way
+## Additional Information
-  [FlopoSite's repo](https://github.com/cassoule/floposite)
+Note that FlopoBot is a work in progress, and new features and improvements are continually being added. Contributions and feedback are welcome ! 
+
+FlopoBot was orriginally created to be integrated in a specific Discord server, so adding it to other servers won't provide the full experience (for now). 
+
+FlopoSite though is public and can be used by anyone :)
+
+## Related Links
+- [FlopoSite Website](https://floposite.com)
+- [FlopoSite Repository](https://github.com/cassoule/floposite)