[Notifier] Document Notifier Mercure options in README file

alamirault · alamirault · commit 9c7036944cb1 · 2025-04-23T23:16:28.000+02:00
diff --git a/src/Symfony/Component/Notifier/Bridge/Mercure/README.md b/src/Symfony/Component/Notifier/Bridge/Mercure/README.md
@@ -14,6 +14,34 @@ where:
  - `HUB_ID` is the Mercure hub id
  - `TOPIC` is the topic IRI (optional, default: `https://symfony.com/notifier`. Could be either a single topic: `topic=https://foo` or multiple topics: `topic[]=/foo/1&topic[]=https://bar`)
 
+
+Adding Options to a Chat Message
+--------------------------------
+
+With a Mercure Chat Message, you can use the `MercureOptions` class to add
+message options.
+
+```php
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Bridge\Mercure\MercureOptions;
+
+$chatMessage = new ChatMessage('Contribute To Symfony');
+
+$options = new MercureOptions(
+    ['/topic/1', '/topic/2'],
+    true,
+    'id',
+    'type',
+    1,
+    ['tag' => '1234', 'body' => 'TEST']
+);
+
+// Add the custom options to the chat message and send the message
+$chatMessage->options($options);
+
+$chatter->send($chatMessage);
+```
+
 Resources
 ---------
 
