From a480be2e31efcfef8a14e0cceb67fcb60ead770f Mon Sep 17 00:00:00 2001
From: Sofiane Lasri-Trienpont <alasri250@gmail.com>
Date: Thu, 13 Feb 2025 09:32:53 +0100
Subject: [PATCH] feat: add README.md with plugin description and installation
 instructions

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9245004
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# PrivateServerPlugin
+
+Un plugin Minecraft développé pour un usage personnel. Ce plugin gère des messages de bienvenue et d'adieu personnalisés pour les joueurs rejoignant ou quittant le serveur.
+
+## Fonctionnalités principales
+- Messages de bienvenue aléatoires pour les joueurs qui rejoignent le serveur.
+- Messages d'adieu basés sur la durée de session des joueurs.
+- Gestion des événements `PlayerJoinEvent` et `PlayerQuitEvent`.
+
+## Prérequis
+- Serveur Minecraft PaperMC compatible avec l'API `1.21.4` ou plus récent.
+- Java 21 ou une version compatible.
+
+## Installation
+1. Compilez le projet avec Maven :
+   ```bash
+   mvn clean package
+   ```
\ No newline at end of file
-- 
GitLab