colornamer 1.0.1

give me a color and I will name it
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# colornamer-rs

Give me a color and I will name it.

*colornamer-rs is in the early stages of development and the api should be considered unstable*

## About

Naming things is one of the hard things in computer science.

Colornamer-rs is a library written in Rust that helps you come up with a good name for a color.

It does this by converting the color to [Lab color space](https://en.wikipedia.org/wiki/Lab_color_space) and using the Delta E formula to compare the color difference in a list of colors with known names and finding the nearest neighbor.

## Example

```rust
extern crate colornamer;

use colornamer::{ColorNamer, Colors};

fn main() {
    let colornamer = ColorNamer::new(Colors::HTML);
    let name: String = colornamer.name_hex_color("#1E90FF").unwrap()

    println!("I will call this color '{}'", name);
}
```

## Lists

The color names are derived from several lists:

* roygbiv
* basic
* HTML
* X11
* Pantone
* ntc - an [astounding collection](http://chir.ag/projects/ntc/) of over 1500 named colors.

## Acknowledgements

This library is based on the wonderful [color-namer](https://github.com/colorjs/color-namer) library for nodejs.

Color difference formulas were found at [easyrgb.com](http://www.easyrgb.com/en/math.php).

Further reading:

* [Wikipedia article for color distance](https://en.wikipedia.org/wiki/Color_difference).

## License

MIT (see LICENSE)