SWAMPy

✎ CARVE FLESH

EDITING: README.md

# WCAGColorContrast

A Ruby port of the Javascript https://github.com/doochik/wcag-color-contrast.

Calculates the contrast ratio between 2 colors, for checking against the WCAG recommended contrast ratio for legibility.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'wcag_color_contrast'
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install wcag_color_contrast
```

## Usage

With 2 hex colors as strings (3 or 6 characters, case insensitive, no leading pound/hash sign):

```ruby
require 'wcag_color_contrast'
WCAGColorContrast.ratio('999', 'ffffff')
#=> 2.849027755287037
```

Can also calculate the relative luminance of a color

```ruby
WCAGColorContrast.relative_luminance('008800')
#=> 0.17608318886144392
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/mkdynamic/wcag_color_contrast/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 lib/	DIR	—	2023-09-24 03:48
📁 test/	DIR	—	2023-09-24 03:48
📄 .gitignore	GITIGNORE	154 B	2023-09-24 03:48	EDIT
📄 Gemfile	?	104 B	2023-09-24 03:48	EDIT
📄 LICENSE.txt	TXT	1 KB	2023-09-24 03:48	EDIT
📄 Rakefile	?	132 B	2023-09-24 03:48	EDIT
📄 README.md	MD	1.1 KB	2023-09-24 03:48	EDIT
📄 wcag_color_contrast.gemspec	GEMSPEC	1002 B	2023-09-24 03:48	EDIT