diff --git a/README.md b/README.md index 5f12f68..7091e54 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# master +## 🎮 À propos +Ce projet est un script personnel de gestion d'un serveur **Hytale**. +Il permet d'automatiser les opérations courantes du serveur, notamment : + +- ▶️ Démarrer le serveur +- ⏹️ Éteindre le serveur +- 🔑 Régénérer les credentials + +> ⚠️ Projet en cours d'expérimentation — la stabilité n'est pas garantie. + +--- + +## 📝 Conventions de commits + +Ce projet suit la convention [Conventional Commits](https://www.conventionalcommits.org/). + +### Format + +``` +(): +``` + +### Types + +| Type | Usage | +|---|---| +| `feat` | Nouvelle fonctionnalité | +| `fix` | Correction de bug | +| `docs` | Documentation uniquement | +| `style` | Formatage, espaces (pas de logique) | +| `refactor` | Réécriture sans changer le comportement | +| `test` | Ajout ou correction de tests | +| `chore` | Maintenance, dépendances, config | + +### Exemples + +``` +feat(server): add auto-restart on crash +fix(credentials): correct token expiration handling +docs(readme): update setup instructions +chore(deps): update dependencies +``` + +### Versioning + +Ce projet suit le [Semantic Versioning](https://semver.org/) : `MAJOR.MINOR.PATCH` + +- `PATCH` → correction de bug (`fix`) +- `MINOR` → nouvelle fonctionnalité (`feat`) +- `MAJOR` → changement cassant (`feat!` ou `fix!`) \ No newline at end of file