color 1.8 → 2.0.0.pre.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 696c2ac0e8282a88cbe1626c779ad336b679f5a1
-  data.tar.gz: c9b3d3786799d258a32120f1560ed16c29a40f7f
+SHA256:
+  metadata.gz: 4e5858bb16512729edfebe8016f4f773cba22557703a83532c0bdf741d1bae34
+  data.tar.gz: ad8833b876bbf9e3b8741044a7d2714c324f4938764745584fe23b3cb0b70be8
 SHA512:
-  metadata.gz: b78ecb062c1ddcc02a98d6b5aad1e060f0f1276dfd82f3f28f2f7c572659dcf98ef9853d519607fee8c44623de006604e6028dfe43d6ab765dc362a346c69978
-  data.tar.gz: f08e750ae6fbb4ac464f6de6657f30bab8e7866fe072aa948c828da8e5881305eaaa254d7e88ca7d2b60fa2aa569fa616a51f836fe4d7f131306493a4a7962ae
+  metadata.gz: 96ad5fe214c3d719626d2ba4a205053f2feccd1d93a405f9f1c9fc3b17afe84a43fb0f1cf2eed24440f1788348bd560f44dbb0510d8994e5c596fd5290a11346
+  data.tar.gz: ce74123cb7c51a3e875bdc8f210df2c6e7b1f5bb64e63f1b9d6de9debd6a2ddab5c3b9d8ceeda19eaee6a90be3b5dbc571df9c6fd1b3d7b8b0d15addf20fc25c

data/CHANGELOG.md

@@ -0,0 +1,298 @@
+# Changelog
+
+## 2.0.0.pre.0 / 2025-06-15
+
+Color 2.0.0 is a major release of the Color library.
+
+### 💣 Breaking Changes
+
+Color 2.0 contains breaking changes. Functionality previously deprecated has
+been removed, but other functionality has been changed or removed as part of
+this release without warning.
+
+- The minimum supported version of Ruby is 3.2.
+
+- Color classes are now immutable implementations of Data objects (first
+  introduced in Ruby 3.2). This will restrict Color 2 from running on versions
+  of JRuby before JRuby 10.
+
+- The constants `Color::COLOR_VERSION` and `Color::COLOR_TOOLS_VERSION` have
+  been removed; there is only `Color::VERSION`. This reverses a planned
+  deprecation decision made more than ten years ago that no longer makes sense.
+
+- All named color classes at `Color` have been removed as planned.
+
+- `Color::RGB::BeccaPurple` has been removed as an alias for
+  `Color::RGB::RebeccaPurple`.
+
+- The pseudo-constructor `Color.new` has been removed.
+
+- Color class constructors no longer yield the constructed color if a block is
+  passed.
+
+- Renamed `Color::COLOR_EPSILON` and `Color::COLOR_TOLERANCE` to
+  `Color::EPSILON` and `Color::TOLERANCE`. These aren't private constants
+  because they need to be accessed throughout Color, but they are _internal_
+  constants that should not be used outside of the Color library or functions
+  exposed therein.
+
+- PDF format functions `#pdf_fill` and `#pdf_stroke` have been removed from
+  `Color::CMYK`, `Color::Grayscale`, and `Color::RGB`. The supporting internal
+  constants `Color::<class>::PDF_FORMAT_STR` have also been removed.
+
+- Palette processing classes, `Color::Palette::AdobeColor`,
+  `Color::Palette::Gimp`, and `Color::Palette::MonoContrast` have been removed.
+  Persons interested in using these are encouraged to extract them from
+  [Color 1.8][color-1.8] and adapt them to use Color 2.0 APIs.
+
+- CSS methods (`#css_rgb`, `#css_rgba`, `#css_hsl`, `#css_hsla`) have been
+  replaced with `#css` on color classes that have CSS representations. The
+  output of `#css` differs (Color 1.8 used the legacy CSS color formats; Color
+  2.0 uses modern CSS color formats).
+
+- `Color::GrayScale` has been renamed to `Color::Grayscale`. The alias constant
+  `Color::GreyScale` has been removed.
+
+- The `#html` method has been removed from all color classes except Color::RGB.
+
+- Named RGB colors are no longer defined automatically, but must be loaded
+  explicitly by requiring `color/rgb/colors`. This resolves [#30][issue-30].
+
+- `Color:CSS#[]` has been removed, as has the containing namespace. It has
+  always been a shallow wrapper around `Color::RGB.by_name`.
+
+### 🚀 New Features
+
+- `Color::CIELAB` and `Color::XYZ` namespaces have been added. Separate
+  implementations were submitted by David Heitzman and @stiff (in [#8][pr-8] and
+  [#11][pr-11]), but I have reworked the code substantially. These
+  implementations were originally as `Color::LAB` and include a new contrast
+  calculation using the ΔE\*00 algorithm.
+
+### Internal
+
+- Updated project structure for how I manage Ruby libraries in 2025. This
+  includes increased release security (MFA is required for all releases,
+  automated releases are enabled), full GitHub Actions, Dependabot, Standard
+  Ruby, and more.
+
+## 1.8 / 2015-10-26
+
+- Add an optional `alpha` parameter to all `#css` calls. Thanks to Luke
+  Bennellick (@bennell) and Alexander Popov (@AlexWayfer) for independently
+  implemented submissions. Merged from [#15][pull-15].
+
+- Improve constant detection to prevent incorrectly identified name collisions
+  with various other libraries such as Azure deployment tools. Based on work by
+  Matthew Draper (@matthewd) in [#24][pull-24].
+
+- Prevent `Color.equivalent?` comparisons from using non-Color types for
+  comparison. Fix provided by Benjamin Guest (@bguest) in [#18][pull-18].
+
+- This project now has a [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## 1.7.1 / 2014-06-12
+
+- Renamed `Color::RGB::BeccaPurple` to `Color::RGB::RebeccaPurple` as stipulated
+  by Eric Meyer. For purposes of backwards compatibility, the previous name is
+  still permitted, but its use is strongly discouraged, and it will be removed
+  in the Color 2.0 release.
+  <http://meyerweb.com/eric/thoughts/2014/06/19/rebeccapurple/>
+
+## 1.7 / 2014-06-12
+
+- Added `Color::RGB::BeccaPurple` (#663399) in honour of Rebecca Meyer, the
+  daughter of Eric Meyer, who passed away on the 7 June 2014. Her favourite
+  color was purple. `#663399becca`
+  <https://twitter.com/meyerweb/status/476089708674428929>
+  <http://www.zeldman.com/2014/06/10/the-color-purple/>
+  <http://discourse.specifiction.org/t/name-663399-becca-purple-in-css4-color/225>
+
+- Changed the homepage in the gem to point to GitHub instead of RubyForge, which
+  has been shut down. Fixes [#10][issue-10], reported by @voxik.
+
+## 1.6 / 2014-05-19
+
+- Aaron Hill (@armahillo) implemented the CIE Delta E 94 method by which an RGB
+  color can be asked for the closest matching color from a list of provided
+  colors. Fixes [#5][issue-5].
+
+- To implement `#closest_match` and `#delta_e94`, conversion methods for sRGB to
+  XYZ and XYZ to L\*a\*b\* space were implemented. These should be considered
+  experimental.
+
+- Ensured that the gem manifest was up-to-date. Fixes [#4][issue-4] reported by
+  @boutil. Thanks!
+
+- Fixed problems with Travis builds. Note that Ruby 1.9.2 is no longer tested.
+  Rubinius remains in a 'failure-tolerated' mode.
+
+- Color 1.6 is, barring security patches, the last release of Color that will
+  support Ruby 1.8.
+
+## 1.5.1 / 2014-01-28
+
+- color 1.5 was a yanked release.
+
+- Added new methods to `Color::RGB` to make it so that the default defined
+  colors can be looked up by hex, name, or both.
+
+- Added a method to `Color::RGB` to extract colors from text by hex, name, or
+  both.
+
+- Added new common methods for color names. Converted colors do not retain
+  names.
+
+- Restructured color comparisons to use protocols instead of custom
+  implementations. This makes it easier to implement new color classes. To make
+  this work, color classes should `include` Color only need to implement
+  `#coerce(other)`, `#to_a`, and supported conversion methods (e.g., `#to_rgb`).
+
+- Added @daveheitzman's initial implementation of a RGB contrast method as an
+  extension file: `require 'color/rgb/contrast'`. This method and the value it
+  returns should be considered experimental; it requires further examination to
+  ensure that the results produced are consistent with the contrast comparisons
+  used in `Color::Palette::MonoContrast`.
+
+- Reducing duplicated code.
+
+- Moved `lib/color/rgb-colors.rb` to `lib/color/rgb/colors.rb`.
+
+- Improved the way that named colors are specified internally.
+
+- Fixed bugs with Ruby 1.8.7 that may have been introduced in color 1.4.2.
+
+- Added simplecov for test coverage analysis.
+
+- Modernized Travis CI support.
+
+## 1.4.2 / 2013-06-30
+
+- Modernized Hoe installation of Color, removing some dependencies.
+
+- Switched to Minitest.
+
+- Turned on Travis CI.
+
+- Started using Code Climate.
+
+- Small code formatting cleanup that touched pretty much every file.
+
+## 1.4.1 / 2010-02-03
+
+- Imported to GitHub.
+
+- Converted to Hoe 2.5 spec format.
+
+## 1.4.0 / 2007-02-11
+
+- Merged Austin Ziegler's color-tools library (previously part of the Ruby PDF
+  Tools project) with Matt Lyon's color library.
+
+  - The HSL implementation from the Color class has been merged into
+    `Color::HSL`. Color is a module the way it was for color-tools.
+
+  - A thin veneer has been written to allow Color::new to return a `Color::HSL`
+    instance; `Color::HSL` supports as many methods as possible that were
+    previously supported by the Color class.
+
+  - Values that were previously rounded by Color are no longer rounded;
+    fractional values matter.
+
+- Converted to hoe for project management.
+
+- Moved to the next step of deprecating `Color::<name>` values; printing a
+  warning for each use (see the history for color-tools 1.3.0).
+
+- Print a warning on the access of either `VERSION` or `COLOR_TOOLS_VERSION`;
+  the version constant is now `COLOR_VERSION`.
+
+- Added humanized versions of accessors (e.g., CMYK colors now have both #cyan
+  and #c to access the cyan component of the color; #cyan provides the value as
+  a percentage).
+
+- Added CSS3 formatters for RGB, RGBA, HSL, and HSLA outputs. Note that the
+  Color library does not yet have a way of setting alpha opacity, so the output
+  for RGBA and HSLA are at full alpha opacity (1.0). The values are output with
+  two decimal places.
+
+- Applied a patch to provide simple arithmetic color addition and subtraction to
+  `Color::GrayScale` and `Color::RGB`. The patch was contributed by Jeremy
+  Hinegardner. This patch also provides the ability to return the maximum RGB
+  value as a grayscale color.
+
+- Fixed two problems reported by Jean Krohn against color-tools relating to
+  RGB-to-HSL and HSL-to-RGB conversion. (Color and color-tools use the same
+  formulas, but the ordering of the calculations is slightly different with
+  Color and did not suffer from this problem; color-tools was more sensitive to
+  floating-point values and precision errors.)
+
+- Fixed an issue with HSL/RGB conversions reported by Adam Johnson.
+
+- Added an Adobe Color swatch (Photoshop) palette reader,
+  `Color::Palette::AdobeColor` (for `.aco` files only).
+
+## Color 0.1.0 / 2006-08-05
+
+- Added HSL (degree, percent, percent) interface.
+
+- Removed RGB instance variable; color is managed internally as HSL floating
+  point.
+
+- Tests!
+
+## color-tools 1.3.0
+
+- Added new metallic colors suggested by Jim Freeze. These are in the namespace
+  `Color::Metallic`.
+
+- Colours that were defined in the Color namespace (e.g., `Color::Red`,
+  `Color::AliceBlue`) are now defined in Color::RGB (e.g., `Color::RGB::Red`,
+  `Color::RGB::AliceBlue`). They are added back to the Color namespace on the
+  first use of the old colors and a warning is printed. In version 1.4, this
+  warning will be printed on every use of the old colors. In version 1.5, the
+  backwards compatible support for colors like Color::Red will be removed
+  completely.
+
+- Added the `Color::CSS` module that provides a name lookup of
+  `Color::RGB`-namespace constants with `Color::CSS[name]`. Most of these colors
+  (which are mirrored from the `Color::RGB` default colors) are only
+  "officially" recognised under the CSS3 color module or SVG.
+
+- Added the `Color::HSL` color space and some helper utilities to `Color::RGB`
+  for color manipulation using the HSL value.
+
+- Controlled internal value replacement to be between 0 and 1 for all colors.
+
+- Updated `Color::Palette::Gimp` to more meaningfully deal with duplicate named
+  colors. Named colors now return an array of colors.
+
+- Indicated the plans for some methods and constants out to color-tools 2.0.
+
+- Added unit tests and fixed a number of hidden bugs because of them.
+
+## color-tools 1.2.0
+
+- Changed installer from a custom-written install.rb to setup.rb 3.3.1-modified.
+
+- Added `Color::GreyScale` (or `Color::GrayScale`).
+
+- Added `Color::YIQ`. This color definition is incomplete; it does not have
+  conversions from YIQ to other color spaces.
+
+## color-tools 1.1.0
+
+- Added `color/palette/gimp` to support the reading and use of GIMP color
+  palettes.
+
+## color-tools 1.0.0
+
+- Initial release.
+
+[color-1.8]: https://github.com/halostatue/color/tree/v1.8
+[css-color]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/color
+[css-device-cmyk]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/device-cmyk
+[issue-10]: https://github.com/halostatue/color/issues/10
+[issue-30]: https://github.com/halostatue/color/issues/30
+[pr-11]: https://github.com/halostatue/color/pull/11
+[pr-8]: https://github.com/halostatue/color/pulls/8

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [INSERT CONTACT
+METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org
+[Mozilla CoC]: https://github.com/mozilla/diversity

data/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contributing
+
+Contribution to color is encouraged in any form: a bug report, a feature
+request, or code contributions. There are a few DOs and DON'Ts for
+
+- DO:
+
+  - Keep the coding style that already exists for any updated Ruby code (support
+    or otherwise). I use [Standard Ruby][standardrb] for linting and formatting.
+
+  - Use thoughtfully-named topic branches for contributions. Rebase your commits
+    into logical chunks as necessary.
+
+  - Use [quality commit messages][qcm].
+
+  - Add your name or GitHub handle to `CONTRIBUTORS.md` and a record in the
+    `CHANGELOG.md` as a separate commit from your main change. (Follow the style
+    in the `CHANGELOG.md` and provide a link to your PR.)
+
+  - Add or update tests as appropriate for your change. The test suite is
+    written with [minitest][minitest].
+
+  - Add or update documentation as appropriate for your change. The
+    documentation is RDoc; color does not use extensions that may be present in
+    alternative documentation generators.
+
+- DO NOT:
+
+  - Modify `VERSION` in `lib/color/version.rb`. When your patch is accepted and
+    a release is made, the version will be updated at that point.
+
+  - Modify `color.gemspec`; it is a generated file. (You _may_ use
+    `rake gemspec` to regenerate it if your change involves metadata related to
+    gem itself).
+
+  - Modify the `Gemfile`.
+
+## Test Dependencies
+
+color uses Ryan Davis's [Hoe][Hoe] to manage the release process, and it adds a
+number of rake tasks. You will mostly be interested in `rake`, which runs the
+tests the same way that `rake test` will do.
+
+To assist with the installation of the development dependencies for mime-types,
+I have provided the simplest possible Gemfile pointing to the (generated)
+`color.gemspec` file. This will permit you to do `bundle install` to get the
+development dependencies.
+
+You can run tests with code coverage analysis by running `rake coverage`.
+
+## Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+- Fork the project.
+- Clone down your fork (`git clone git://github.com/<username>/color.git`).
+- Create a topic branch to contain your change
+  (`git checkout -b my_awesome_feature`).
+- Hack away, add tests. Not necessarily in that order.
+- Make sure everything still passes by running `rake`.
+- If necessary, rebase your commits into logical chunks, without errors.
+- Push the branch up (`git push origin my_awesome_feature`).
+- Create a pull request against halostatue/color and describe what your change
+  does and the why you think it should be merged.
+
+[hoe]: https://github.com/seattlerb/hoe
+[minitest]: https://github.com/seattlerb/minitest
+[mtd]: https://github.com/mime-types/mime-types-data
+[qcm]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[standardrb]: https://github.com/standardrb/standard

data/CONTRIBUTORS.md

@@ -0,0 +1,10 @@
+# Contributors
+
+- Austin Ziegler created color-tools.
+- Matt Lyons created color.
+- Dave Heitzman (contrast comparison, CIELAB color support)
+- Thomas Sawyer
+- Aaron Hill (CIE94 color matching)
+- Luke Bennellick
+- @stiff (CIELAB color support)
+- Matthew Draper

data/LICENCE.md

@@ -0,0 +1,27 @@
+# Licence
+
+- Copyright 2005-2025 Austin Ziegler, Matt Lyon, and other contributors.
+
+The software in this repository is made available under the MIT license.
+
+## MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+- The names of its contributors may not be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,39 +1,27 @@
-.autotest
-.coveralls.yml
-.gemtest
-.hoerc
-.minitest.rb
-.travis.yml
-Code-of-Conduct.rdoc
-Contributing.rdoc
-Gemfile
-History.rdoc
-Licence.rdoc
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CONTRIBUTORS.md
+LICENCE.md
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
+SECURITY.md
 lib/color.rb
+lib/color/cielab.rb
 lib/color/cmyk.rb
-lib/color/css.rb
 lib/color/grayscale.rb
 lib/color/hsl.rb
-lib/color/palette.rb
-lib/color/palette/adobecolor.rb
-lib/color/palette/gimp.rb
-lib/color/palette/monocontrast.rb
 lib/color/rgb.rb
 lib/color/rgb/colors.rb
-lib/color/rgb/contrast.rb
-lib/color/rgb/metallic.rb
+lib/color/version.rb
+lib/color/xyz.rb
 lib/color/yiq.rb
+test/fixtures/cielab.json
 test/minitest_helper.rb
-test/test_adobecolor.rb
 test/test_cmyk.rb
 test/test_color.rb
-test/test_css.rb
-test/test_gimp.rb
 test/test_grayscale.rb
 test/test_hsl.rb
-test/test_monocontrast.rb
 test/test_rgb.rb
 test/test_yiq.rb

data/README.md

@@ -0,0 +1,54 @@
+# Color -- Color Math in Ruby
+
+- code :: <https://github.com/halostatue/color>
+- issues :: <https://github.com/halostatue/color/issues>
+- changelog :: <https://github.com/halostatue/color/blob/main/CHANGELOG.md>
+- continuous integration ::
+  [![Build Status](https://github.com/halostatue/color/actions/workflows/ci.yml/badge.svg)][ci-workflow]
+- test coverage ::
+  [![Coverage](https://coveralls.io/repos/halostatue/color/badge.svg?branch=main&service=github)][coveralls]
+
+## Description
+
+Color is a Ruby library to provide RGB, CMYK, HSL, and other color space
+manipulation support to applications that require it. It provides optional named
+RGB colors that are commonly supported in HTML, # SVG, and X11 applications.
+
+The Color library performs purely mathematical manipulation of the colors based
+on color theory without reference to device color profiles (such as sRGB or
+Adobe RGB). For most purposes, when working with RGB and HSL color spaces, this
+won't matter. Absolute color spaces (like CIE LAB and CIE XYZ) cannot be
+reliably converted to relative color spaces (like RGB) without color profiles.
+When necessary for conversions, Color provides D65 and D50 reference white
+values in Color::XYZ.
+
+Color 2.0 is a major release, dropping support for all versions of Ruby prior to
+3.2 as well as removing or renaming a number of features. The main breaking
+changes are:
+
+- Color classes are immutable Data objects; they are no longer mutable.
+- RGB named colors are no longer loaded on gem startup, but must be required
+  explicitly (this is _not_ done via `autoload` because there are more than 100
+  named colors with spelling variations) with `require "color/rgb/colors"`.
+- Color palettes have been removed.
+- `Color::CSS` and `Color::CSS#[]` have been removed.
+
+## Examples
+
+Suppose you want to make a given RGB color a little lighter. Adjusting the RGB
+color curves will change the hue and saturation will also change. Instead, use
+the CIE LAB color space keeping the `color` components intact, altering only the
+lightness component:
+
+```ruby
+c = Color::RGB.from_values(r, g, b).to_lab
+
+if (t = c.l / 50.0) < 1
+  c.l = 50 * ((1.0 - t) * Math.sqrt(t) + t**2)
+end
+
+c.to_rgb
+```
+
+[ci-workflow]: https://github.com/halostatue/color/actions/workflows/ci.yml
+[coveralls]: https://coveralls.io/github/halostatue/color?branch=main