From fb2617449dd4bc7764cacefd9ce8b033322ab537 Mon Sep 17 00:00:00 2001 From: Prachi Gauriar Date: Mon, 1 Sep 2025 22:48:59 -0400 Subject: [PATCH 1/2] Add docc documentation --- README.md | 2 +- .../Documentation.docc/Documentation.md | 16 ++++++++++++++++ .../Documentation.docc/Info.plist | 8 ++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 Sources/DevColorExtraction/Documentation.docc/Documentation.md create mode 100644 Sources/DevColorExtraction/Documentation.docc/Info.plist diff --git a/README.md b/README.md index 6fdabc6..09fb88e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ View our [changelog](CHANGELOG.md) to see what’s new. ## Features - - Extract the most common colors from `CGImage` using Core Image's k-means clustering + - Extract the most common colors from `CGImage` using Core Image’s k-means clustering - Support for edge-based color extraction (top, left, bottom, right edges) - Configurable number of colors and clustering passes - Results include both colors and their relative weights diff --git a/Sources/DevColorExtraction/Documentation.docc/Documentation.md b/Sources/DevColorExtraction/Documentation.docc/Documentation.md new file mode 100644 index 0000000..ad57a50 --- /dev/null +++ b/Sources/DevColorExtraction/Documentation.docc/Documentation.md @@ -0,0 +1,16 @@ +# ``DevColorExtraction`` + +Extract the most common colors out of an image. + +## Overview + +DevColorExtraction is a small Swift package that extracts the most common colors from images using +k-means clustering. It provides efficient color analysis with support for edge-based extraction. +All of the package’s functionality is exposed through a single function on `CGImage`: +``CoreGraphics/CGImage/mostCommonColors(count:passes:edges:)``. + + +## Topics + +- ``CoreGraphics/CGImage`` +- ``EdgeSet`` diff --git a/Sources/DevColorExtraction/Documentation.docc/Info.plist b/Sources/DevColorExtraction/Documentation.docc/Info.plist new file mode 100644 index 0000000..958f6c8 --- /dev/null +++ b/Sources/DevColorExtraction/Documentation.docc/Info.plist @@ -0,0 +1,8 @@ + + + + + CDDefaultCodeListingLanguage + swift + + From 68d7f28df60bf197330c010bbeaa5dad0b0922ae Mon Sep 17 00:00:00 2001 From: Prachi Gauriar Date: Mon, 1 Sep 2025 22:54:08 -0400 Subject: [PATCH 2/2] Update changelog with release date for 1.0.0 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 78d3e71..64c5370 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # DevColorExtraction Changelog -## 1.0.0 – TBD +## 1.0.0: September 1, 2025 This is the first release of DevColorExtraction. The initial feature set includes