chore: improve readme (getSimilarText and textToColor)

tomloprod · May 26, 2024 · 34cf4dc · 34cf4dc
1 parent fa22fec
commit 34cf4dc
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -200,16 +200,20 @@ $hslColor = $hexColor->toHsl();
 
 Generate a fixed color based on a string.
 
+![getSimilarColor gif](./docs/example-text-to-color.gif)
+
 ```php
 /** @var HslColor $hslColor */
 $hslColor = colority()->textToColor("Hi, I'm Tomás");
 ```
 > **🧙 Advise** 
-> Useful for generating a color associated with, for example, a username, mail address, etc, since a string will always return the same color.
+> Useful for generating a color associated with, for example, **a username, mail address, etc**, since a string will always return the same color.
 
 #### getSimilarColor
 Allows you to obtain a random color similar (*in the same color palette*) to a given color.
 
+![getSimilarColor gif](./docs/example-get-similar-color.gif)
+
 ```php
 /** @var HexColor|null $hexColor */
 $hexColor = colority()->fromHex('#51B389');

diff --git a/docs/example-get-similar-color.gif b/docs/example-get-similar-color.gif
diff --git a/docs/example-get-similar-color.mp4 b/docs/example-get-similar-color.mp4
diff --git a/docs/example-text-to-color.gif b/docs/example-text-to-color.gif
diff --git a/docs/example-text-to-color.mp4 b/docs/example-text-to-color.mp4