https://github.com/shariati/cherangi

A small javascript library that finds an exact or similar color name.
https://github.com/shariati/cherangi

colors javascript javascript-library nodejs npm npm-package

Last synced: 3 months ago
JSON representation

A small javascript library that finds an exact or similar color name.

• Host: GitHub
• URL: https://github.com/shariati/cherangi
• Owner: shariati
• License: mit
• Created: 2017-08-27T10:30:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-16T10:26:46.000Z (over 1 year ago)
• Last Synced: 2024-10-10T07:46:46.381Z (8 months ago)
• Topics: colors, javascript, javascript-library, nodejs, npm, npm-package
• Language: JavaScript
• Size: 1.81 MB
• Stars: 19
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cherangi

[![npm version](https://badge.fury.io/js/cherangi.svg)](https://badge.fury.io/js/cherangi)

[![Known Vulnerabilities](https://snyk.io/test/github/shariati/cherangi/badge.svg)](https://snyk.io/test/github/shariati/cherangi)

# ⚠️ Discontinued - Please Use color-names Instead

This project has been discontinued in favor of [color-names](https://github.com/meodai/color-names), which provides all the features of Cherangi and much more:

- **Larger Color Database**: Over 30,000 unique color names

- **Multiple Language Support**: Java, Kotlin, C#, and JavaScript

- **Free Public REST API**: Easy to integrate with any platform

- **Better Color Matching**: More accurate color-to-name mapping

- **Regular Updates**: Actively maintained and frequently updated

- **Multiple Format Support**: JSON, CSV, YML, XML, HTML, SCSS

- **CDN Available**: For quick integration

- **Well Documented**: Comprehensive documentation and examples

## Migration Guide

To migrate from Cherangi to color-names, please visit:

[color-names Documentation](https://github.com/meodai/color-names#readme)

### Quick Start with color-names

```javascript

// Install

npm install color-name-list

// Usage

import { colornames } from 'color-name-list';

// Find exact color

const color = colornames.find(color => color.hex === '#ffffff');

console.log(color.name); // => white

// Find closest color using their API

// https://api.color.pizza/v1/?values=00f,f00,f00

```

## Historical Information

Cherangi (چه رنگی) means "What color?" in Farsi (Persian). This project was created to help developers find color names programmatically, but has since been superseded by the more comprehensive color-names project.

## Thanks

Special thanks to all contributors and users who supported this project. For continued color naming needs, please support the [color-names](https://github.com/meodai/color-names) project.

## License

MIT © [Amin Shariati](LICENSE)