Skip to content

Mark readme examples as ruby #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjankowski wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mark readme examples as ruby #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 28 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Color Diff

Calculating differences between colors using the CIEDE2000 algorithm
Calculating differences between colors using the [CIEDE2000 algorithm].

## Install

Expand All @@ -10,32 +10,40 @@ Calculating differences between colors using the CIEDE2000 algorithm

Difference between two colors:

yellow = ColorDiff::Color::RGB.new 255, 255, 0
gold = ColorDiff::Color::RGB.new 255, 215, 0
```ruby
yellow = ColorDiff::Color::RGB.new 255, 255, 0
gold = ColorDiff::Color::RGB.new 255, 215, 0

ColorDiff.between yellow, gold
# => 11.584521223499245
ColorDiff.between yellow, gold
# => 11.584521223499245
```

Picking the most similar color from a list:

red = ColorDiff::Color::RGB.new 255, 0, 0
blue = ColorDiff::Color::RGB.new 0, 0, 255
yellow = ColorDiff::Color::RGB.new 255, 255, 0
gold = ColorDiff::Color::RGB.new 255, 215, 0
```ruby
red = ColorDiff::Color::RGB.new 255, 0, 0
blue = ColorDiff::Color::RGB.new 0, 0, 255
yellow = ColorDiff::Color::RGB.new 255, 255, 0
gold = ColorDiff::Color::RGB.new 255, 215, 0

list = ColorDiff::List.new [red, blue, yellow]
list.closest_to(gold) == yellow
# => true
list = ColorDiff::List.new [red, blue, yellow]
list.closest_to(gold) == yellow
# => true
```

Building a map of nearest match colors from a finite palette:

red = ColorDiff::Color::RGB.new 255, 0, 0
black = ColorDiff::Color::RGB.new 0, 0, 0
dark_gray = ColorDiff::Color::RGB.new 80, 80, 80
maroon = ColorDiff::Color::RGB.new 128, 0, 0
```ruby
red = ColorDiff::Color::RGB.new 255, 0, 0
black = ColorDiff::Color::RGB.new 0, 0, 0
dark_gray = ColorDiff::Color::RGB.new 80, 80, 80
maroon = ColorDiff::Color::RGB.new 128, 0, 0

list = ColorDiff::List.new [red, black]
palette = [dark_gray, maroon]
list = ColorDiff::List.new [red, black]
palette = [dark_gray, maroon]

list.closest_to_map(palette)
# => { 'R255G0B0' => maroon, 'R0B0G0' => dark_gray }
list.closest_to_map(palette)
# => { 'R255G0B0' => maroon, 'R0B0G0' => dark_gray }
```

[CIEDE2000 algorithm]: https://en.wikipedia.org/wiki/Color_difference#CIEDE2000