Doc minimale

README.md

 Module UnicaenAlerte
 ====================
 
+Ce module permet d'afficher des alertes sur une page de votre application, sous la forme :
+  - d'un Toast Bootstrap,
+  - ou d'une Alerte Bootstrap,
+  - d'une `alert` Javascript.
+
+Pour l'instant :
+  - le module puise les alertes uniquement dans une base de données ;
+  - le module ne propose pas de formulaire pour ajouter/modifier/supprimer des alertes en base de données.
+
+
+Exemples
+--------
+
+Le module fournit une aide de vue `alertes` (cf. `UnicaenAlerte\View\Helper\AlerteViewHelper`).
+
+```php
+// Affichage de toutes les alertes, sous forme d'un Toast Bootstrap à condition que leur planning
+// d'affichage inclue la date du jour :
+echo $this->alertes()->withMatchingPlanning()->renderAsBootstrapToasts();
+
+// Affichage d'une alerte identifiée par son code, sous forme d'un Toast Bootstrap à condition que son planning
+// d'affichage inclue la date du jour :
+echo $this->alertes()->withCode('ALERTE_SOUTENANCE')->withMatchingPlanning()->renderAsBootstrapToasts();
+
+// Affichage d'une alerte identifiée par son code, sous forme d'un Toast Bootstrap, quelque soit son planning :
+echo $this->alertes()->withCode('ALERTE_SOUTENANCE')->renderAsBootstrapToasts();
+
+// Affichage d'alertes identifiées par leur code, sous forme d'une Alert Bootstrap, quelque soit son planning :
+echo $this->alertes()->withCodes('ALERTE_SOUTENANCE', 'ALERTE_FERMETURE')->renderAsBootstrapAlerts();
+```
+
 
 Installation
 ------------
@@ -11,6 +42,9 @@ Installation
 composer require unicaen/alerte
 ```
 
+N'oubliez pas d'activer le module dans `config/application.config.php`.
+
+
 ### Base de données
 
 Cf. [Script SQL de création des objets](./data/sql/schema.pgsql.sql)