diff --git a/cookcli/README.md b/cookcli/README.md index ce89860..c7f5053 100644 --- a/cookcli/README.md +++ b/cookcli/README.md @@ -1,42 +1,32 @@ -# CookCLI Server Add-on pour Home Assistant +# CookCLI Server Add-on -Serveur CookCLI avec synchronisation Git automatique pour gérer vos recettes Cooklang. +![Version](https://img.shields.io/badge/version-0.10.0-blue.svg) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) -## 🚀 Fonctionnalités +Serveur CookCLI avec synchronisation Git automatique -- Serveur CookCLI prêt à l'emploi -- Synchronisation Git automatique des recettes -- Interface accessible via le port 9080 -- Intégration avec l'API CookCLI pour Home Assistant +--- -## 📦 Installation +## 🚀 Installation rapide -1. Ajoutez ce dépôt en tant que dépôt d'add-ons dans Home Assistant -2. Installez l'add-on "CookCLI Server" -3. Configurez les options (dépôt Git, intervalle de sync, etc.) -4. Démarrez l'add-on +[![Open your Home Assistant instance and show the add app repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgit.thethomaas.net%2FTheThomaas%2Fhome-assistant-apps) + +1. **Ajoutez le dépôt** dans Supervisor → Add-ons → Dépôts : + ``` + https://git.thethomaas.net/TheThomaas/home-assistant-apps + ``` +2. **Installez** l'add-on "CookCLI Server". +3. **Configurez** (au minimum `git_repository`). +4. **Démarrez** l'add-on. + +--- ## ⚙️ Configuration -### Options disponibles - -- `recipes_path` : Dossier où stocker les recettes (défaut: `/config/recipes`) -- `port` : Port du serveur (défaut: 9080) -- `log_level` : Niveau de log (debug, info, warning, error) -- `git_repository` : URL du dépôt Git (ex: https://github.com/user/recipes.git) -- `git_branch` : Branche à utiliser (défaut: main) -- `git_sync_interval` : Intervalle de synchronisation en secondes (défaut: 3600) -- `git_username` : Nom d'utilisateur pour l'authentification (optionnel) -- `git_password` : Mot de passe ou token (optionnel) - -### Exemple avec dépôt Git - ```yaml -recipes_path: /config/recipes -port: 9080 -log_level: info -git_repository: https://github.com/mon-user/mes-recettes.git +git_repository: https://github.com/user/recipes.git # Obligatoire git_branch: main git_sync_interval: 3600 -git_username: mon-user -git_password: mon-token-github \ No newline at end of file +git_username: "" # Pour dépôt privé +git_password: "" # Token ou mot de passe +```