Update documentations for v0.7.0 release (#146)

Author: t28hub

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+All notable changes to this project will be documented in this file.
+
+## [v0.7.0](https://github.com/t28hub/auto-palette/releases/tag/v0.7.0)
+
+* Introduced the ability to accept input directly from the system clipboard.(#140)
+* Modified the image crate usage to exclude default features, reducing the number of dependencies and optimizing build times.(#144)
+* Refactored the color module to optimize internal implementations and enhance color conversion accuracy.(#141)
+* Updated the find_swatches_with_theme method to employ diversity sampling strategies.(#136)
+
+
 ## [v0.6.0](https://github.com/t28hub/auto-palette/releases/tag/v0.6.0)
 
 * Add methods to convert `Color` to and from `ColorInt` (integer representation).

Cargo.toml

@@ -4,7 +4,7 @@ members  = ["crates/*"]
 
 [workspace.package]
 edition    = "2021"
-version    = "0.6.0"
+version    = "0.7.0"
 authors    = ["Tatsuya Maki <[email protected]>"]
 license    = "MIT"
 homepage   = "https://github.com/t28hub/auto-palette"
@@ -14,7 +14,7 @@ repository = "https://github.com/t28hub/auto-palette"
 anyhow                   = "1.0.97"
 arboard                  = "3.4.1"
 assert_cmd               = "2.0.14"
-auto-palette             = { version = "0.6.0", path = "crates/auto-palette", default-features = false }
+auto-palette             = { version = "0.7.0", path = "crates/auto-palette", default-features = false }
 clap                     = { version = "4.5.4", features = ["cargo"] }
 getrandom                = "0.3.1"
 image                    = { version = "0.25.1", default-features = false }

README.md

@@ -1,13 +1,22 @@
 # auto-palette
 
-> 🎨 `auto-palette` is a library that automatically extracts prominent color palettes from images, available for Rust ,Wasm and as a CLI tool.
+> 🎨 `auto-palette` is a library that automatically extracts prominent color palettes from images, available as Rust library, WebAssembly and CLI tool.
 
 [![Build](https://img.shields.io/github/actions/workflow/status/t28hub/auto-palette/ci.yml?style=flat-square)](https://github.com/t28hub/auto-palette/actions/workflows/ci.yml)
 [![License](https://img.shields.io/crates/l/auto-palette?style=flat-square)](https://crates.io/crates/auto-palette)
 [![Version](https://img.shields.io/crates/v/auto-palette?style=flat-square)](https://crates.io/crates/auto-palette)
 [![Codacy grade](https://img.shields.io/codacy/grade/5de09d1930244071a2fa39d5cfcd8633?style=flat-square)](https://app.codacy.com/gh/t28hub/auto-palette/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Codecov](https://img.shields.io/codecov/c/github/t28hub/auto-palette?style=flat-square)](https://codecov.io/gh/t28hub/auto-palette)
 
+## Overview
+`auto-palette` is a Rust project that offers color palette extraction from images. It consists of the following components:
+
+* `auto-palette`: Core library for programmatic usage.
+* `auto-palette-cli`: Command-line interface for easy usage.
+* `auto-palette-wasm`: WebAssembly version for browser usage.
+
+Perfect for developers, designers and anyone needing efficient color palette extraction.
+
 ## Features
 
 <img src="gfx/laura-clugston-pwW2iV9TZao-unsplash.jpg" alt="Hot air balloon on blue sky" width="480">
@@ -17,24 +26,24 @@
 > Photo by <a href="https://unsplash.com/@laurahclugston?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Laura Clugston</a> on <a href="https://unsplash.com/photos/multi-colored-hot-air-balloon-pwW2iV9TZao?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>
 
 * Automatically extracts prominent color palettes from images.
-* Provides detailed information on color, position, and population.
-* Supports multiple extraction algorithms, including `DBSCAN`, `DBSCAN++`, and `KMeans++`.
-* Supports multiple color spaces, including `RGB`, `HSL`, and `LAB`.
-* Supports the selection of prominent colors based on multiple themes, including `Vivid`, `Muted`, `Light`, and `Dark`.
+* Provides detailed color swatch information (color, position, population)
+* Supports multiple extraction algorithms: `DBSCAN`, `DBSCAN++`, and `KMeans++`.
+* Supports numerous color spaces: `RGB`, `HSL`, `LAB`, `LCHuv`, `ANSI256` and more.
+* Theme-based swatch selection: `Basic`, `Colorful`, `Vivid`, `Muted`, `Light`, and `Dark`.
 * Available as a Rust library, Wasm, and a CLI tool.
 
 ## Installation
 
-### Rust
+### Rust Library
 
 To use `auto-palette` in your Rust project, add it to your `Cargo.toml`.
 
 ```toml
 [dependencies]
-auto-palette = "0.6.0"
+auto-palette = "0.7.0"
 ```
 
-### CLI
+### CLI Tool
 
 To use command-line interface, install the `auto-palette-cli` crate.
 
@@ -44,7 +53,7 @@ cargo install auto-palette-cli
 
 ## Usage
 
-### Rust
+### Rust Example
 
 Here is an example of extracting the color palette from an image using the Rust library.
 See the [examples](crates/auto-palette/examples) directory for more examples.
@@ -71,7 +80,7 @@ fn main() {
 }
 ```
 
-### CLI
+### CLI Example
 
 Here is an example of extracting the color palette from an image using the CLI tool.
 

crates/auto-palette-cli/README.md

@@ -9,21 +9,39 @@
 ## Features
 
 - Extract prominent color palettes from images.
-- Supports multiple color extraction algorithms (`dbscan`, `dbscan++`, `kmeans`). Defaults to `dbscan`.
-- Supports multiple color selection themes (`basic`, `colorful`, `vivid`, `muted`, `light`, `dark`). Defaults to `basic`.
+- Supports multiple color extraction algorithms: `dbscan`, `dbscan++`, and `kmeans`. (default: `dbscan`).
+- Flexible theme selection for color swatches: `basic`, `colorful`, `vivid`, `muted`, `light`, and `dark`. (default: `basic`).
 - Supports multiple color formats (`hex`, `rgb`, `cmyk`, `hsl`, `hsv`, `lab`, `luv`, `lchab`, `lchuv`, `oklab`, `oklch`, `xyz`). Defaults to `hex`.
-- Outputs the color palette in multiple formats (`json`, `text`, `table`). Defaults to `text`.
+- Multiple output formats: `json`, `text`, and `table`. (default: `text`).
+- Clipboard support for instant palette extraction.
 
 ## Installation
 
 ```sh
 cargo install auto-palette-cli
 ```
 
+## Quick Start
+
+Extract a simple 5 color palette from an image:
+```sh
+auto-palette path/to/your_image.jpg
+```
+
+Extract a 5 color palette from an image using the `vivid` theme and `rgb` color format with `table` output format:
+```sh
+auto-palette path/to/your_image.jpg -n 5 -a dbscan++ -t vivid -c rgb -o table
+```
+
+Extract a color palette from clipboard image:
+```sh
+auto-palette --clipboard
+```
+
 ## Usage
 
 ```sh
-$ auto-palette --help
+$ auto-palette -h
 🎨 A CLI tool to extract prominent color palettes from images.
 
 Usage: auto-palette [OPTIONS] <PATH>
@@ -38,6 +56,7 @@ Options:
   -c, --color <name>      Output color format. [default: hex] [possible values: hex, rgb, cmyk, hsl, hsv, lab, luv, lchab, lchuv, oklab, oklch, xyz]
   -o, --output <name>     Output format. [default: text] [possible values: json, text, table]
       --no-resize         Disable image resizing before extracting the color palette.
+      --clipboard         Get image from system clipboard
   -h, --help              Print help (see more with '--help')
   -V, --version           Print version
 ```

crates/auto-palette/README.md

@@ -18,23 +18,22 @@
 
 * Automatically extracts prominent color palettes from images.
 * Provides detailed information on color, position, and population.
-* Supports multiple extraction algorithms, including `DBSCAN`, `DBSCAN++`, and `KMeans++`.
-* Supports multiple color spaces, including `RGB`, `HSL`, and `LAB`.
-* Supports the selection of prominent colors based on multiple themes, including `Vivid`, `Muted`, `Light`, and `Dark`.
+* Supports multiple extraction algorithms: `DBSCAN`, `DBSCAN++`, and `KMeans++`.
+* Supports numerous color spaces: `RGB`, `HSL`, `LAB` and more.
+* Theme-based swatch selection: `Basic`, `Colorful`, `Vivid`, `Muted`, `Light`, and `Dark`.
 
 ## Installation
 
 Using `auto-palette` in your Rust project, add it to your `Cargo.toml`.
 
 ```toml
 [dependencies]
-auto-palette = "0.6.0"
+auto-palette = "0.7.0"
 ```
 
 ## Usage
 
 Here is a basic example that demonstrates how to extract the color palette and find the prominent colors.
-See the [examples](./examples) directory for more examples.
 
 ```rust
 use auto_palette::{ImageData, Palette};
@@ -57,14 +56,16 @@ fn main() {
 }
 ```
 
-## API
+For more advanced examples, see the [examples](./examples) directory.
+
+## Documentation
+
+See the full documentation on [docs.rs](https://docs.rs/auto-palette/latest/auto_palette/).
 
 * [`ImageData`](#imagedata)
 * [`Palette`](#palette)
 * [`Swatch`](#swatch)
 
-For more information on the API, see the [documentation](https://docs.rs/auto-palette).
-
 ### `ImageData`
 
 The `ImageData` struct represents the image data that is used to extract the color palette.
@@ -77,9 +78,14 @@ The `ImageData` struct represents the image data that is used to extract the col
 #### `ImageData::load`
 
 Loads the image data from the file.  
-The supported image formats are `PNG`, `JPEG`, `GIF`, `BMP`, `TIFF`, and `WEBP`.  
 This method requires the `image` feature to be enabled. The `image` feature is enabled by default.
 
+```toml
+[dependencies]
+auto-palette = { version = "0.7.0", features = ["image"] }
+image        = { version = "0.25.6", features = ["jpeg"] } # if you want to load jpeg images
+```
+
 ```rust
 // Load the image data from the file
 let image_data = ImageData::load("path/to/image.jpg").unwrap();