chore: getImageColors in readme.md

tomloprod · Jun 3, 2024 · c5df1fd · c5df1fd
1 parent 59e48c6
commit c5df1fd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -196,6 +196,22 @@ $hslColor = $hexColor->toHsl();
 
 ### Color utilities
 
+#### getImageColors
+
+It allows you to obtain the colors detected in an image. As the first argument, the path to the image must be provided. 
+
+It has an optional second parameter (default is 5) that specifies the number of colors to be returned.
+
+![getImageColors gif](./docs/example-get-image-colors.gif)
+
+```php
+/** @var array<RgbColor> $imageColors */
+$imageColors = colority()->getImageColors(
+    imagePath: __DIR__.'/image-colors.png',
+    desiredNumColors: 10
+);
+```
+
 #### textToColor
 
 Generate a fixed color based on a string.

diff --git a/docs/example-get-image-colors.gif b/docs/example-get-image-colors.gif