From 3ea855502b53ed378b21fa93dddd26088f5b7437 Mon Sep 17 00:00:00 2001
From: Daniil Gentili <daniil@daniil.it>
Date: Tue, 16 Apr 2024 19:30:43 +0200
Subject: [PATCH] Update examples

---
 README.md          | 27 ++++++++++++++++++++++++++-
 examples/1-all.php | 23 +++++++++++++++++++++++
 2 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bf0cc95..6204296 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
 
 A library to work with Telegram UTF-16 styled text entities, created by Daniil Gentili (https://daniil.it).  
 
-This library can be used to modify entities returned by the Telegram Bot API, or even locally generate them using a custom MarkdownV2 and HTML parser inside of the library.  
+This library can be used to modify entities returned by the Telegram Bot API, convert entities to HTML or even locally generate them using a custom MarkdownV2 and HTML parser inside of the library.  
 
 This library was initially created for [MadelineProto](https://docs.madelineproto.xyz), an async PHP client API for the telegram MTProto protocol.  
 
@@ -74,6 +74,31 @@ $sm($entities->message, entities: $entities->entities);
 // Convert markdown to an array of entities locally
 $entities = Entities::fromMarkdown("*This is _a ❤️ nested_ test*");
 $sm($entities->message, entities: $entities->entities);
+
+// Escape text using utility methods
+$generic = EntityTools::markdownEscape("Automatically escaped to prevent *markdown injection*!");
+$link = EntityTools::markdownUrlEscape("https://google.com");
+$code = EntityTools::markdownCodeEscape("test with autoescaped ` test");
+$codeBlock = EntityTools::markdownCodeblockEscape("<?php echo 'test with autoescaped ``` test';");
+
+$entities = Entities::fromMarkdown("This is _a ❤️ [nested]($link)_ `$code`
+
+```php
+$codeBlock
+```
+
+$generic
+");
+
+$sm($entities->message, entities: $entities->entities);
+
+// Escape text for the HTML parser!
+$generic = EntityTools::htmlEscape("Automatically escaped to prevent <b>HTML injection</b>!");
+$entities = Entities::fromHtml($generic);
+
+$sm($entities->message, entities: $entities->entities);
+
+// See https://github.com/danog/telegram-entities for the full list of available methods!
 ```
 
 Many more methods are available, see the [API documentation](https://github.com/danog/telegram-entities/blob/master/docs/docs/index.md) for the full list!
diff --git a/examples/1-all.php b/examples/1-all.php
index 05a8b4c..a28e568 100644
--- a/examples/1-all.php
+++ b/examples/1-all.php
@@ -53,4 +53,27 @@ $sm($entities->message, entities: $entities->entities);
 $entities = Entities::fromMarkdown("*This is _a ❤️ nested_ test*");
 $sm($entities->message, entities: $entities->entities);
 
+// Escape text using utility methods
+$generic = EntityTools::markdownEscape("Automatically escaped to prevent *markdown injection*!");
+$link = EntityTools::markdownUrlEscape("https://google.com");
+$code = EntityTools::markdownCodeEscape("test with autoescaped ` test");
+$codeBlock = EntityTools::markdownCodeblockEscape("<?php echo 'test with autoescaped ``` test';");
+
+$entities = Entities::fromMarkdown("This is _a ❤️ [nested]($link)_ `$code`
+
+```php
+$codeBlock
+```
+
+$generic
+");
+
+$sm($entities->message, entities: $entities->entities);
+
+// Escape text for the HTML parser!
+$generic = EntityTools::htmlEscape("Automatically escaped to prevent <b>HTML injection</b>!");
+$entities = Entities::fromHtml($generic);
+
+$sm($entities->message, entities: $entities->entities);
+
 // See https://github.com/danog/telegram-entities for the full list of available methods!