Skip to content

Commit a22ba56

Browse files
committed
2 parents a189bb4 + c79cf92 commit a22ba56

File tree

3 files changed

+31
-30
lines changed

3 files changed

+31
-30
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
# 🍭 Chromanomer
33
<p>
44
<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/arvindcheenu/chromanomer?style=flat-square">
5-
<img alt="npm" src="https://img.shields.io/npm/v/chromanomer?color=cc3534&style=flat-square">
6-
<img alt="npm" src="https://img.shields.io/npm/dt/chromanomer?label=overall%20downloads&style=flat-square">
7-
<img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/min/chromanomer?label=npm%20bundle%20size&style=flat-square">
8-
<img alt="npm dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=0&color=brightgreen&style=flat-square">
9-
<img alt="NPM" src="https://img.shields.io/npm/l/chromanomer?style=flat-square">
5+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="npm" src="https://img.shields.io/npm/v/chromanomer?color=cc3534&style=flat-square"></a>
6+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/min/chromanomer?label=npm%20bundle%20size&style=flat-square"></a>
7+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="npm dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=0&color=brightgreen&style=flat-square"></a>
8+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="NPM" src="https://img.shields.io/npm/l/chromanomer?style=flat-square"></a>
109
<br/>
1110
</p>
1211

docs/STYLE.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
- [💄 **Sass Api**](#-sass-api)
44
- [🎛️ **Functions**](#%EF%B8%8F-functions)
5-
- [#️⃣ percentMatch(\$str, \$substr) ⇒ Number](%EF%B8%8F⃣-percentmatchstr-substr--number)
6-
- [#️⃣ cono(\$name, \$opacity) ⇒ Sass::Color](%EF%B8%8F⃣-cononame-opacity--sasscolor)
5+
- [#️⃣ percentMatch(\$str, \$substr) ⇒ Number](#%EF%B8%8F⃣-percentmatchstr-substr--number)
6+
- [#️⃣ cono(\$name, \$opacity) ⇒ Sass::Color](#%EF%B8%8F⃣-cononame-opacity--sasscolor)
77
- [#️⃣ get-all-matching(\$substring,\$opacity) ⇒ Sass::List](#%EF%B8%8F⃣-get-all-matchingsubstringopacity--sasslist)
88
- [🎛️ **Mixins**](#%EF%B8%8F-mixins)
99
- [#️⃣ color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-colorname-opacity--sassmixin)
1010
- [#️⃣ background-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-background-colorname-opacity--sassmixin)
1111
- [#️⃣ text-decoration-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-text-decoration-colorname-opacity--sassmixin)
12-
- [#️⃣ text-emphasis-color(\$name, \$opacity) ⇒ Sass::Mixin](##%EF%B8%8F⃣-text-emphasis-colorname-opacity--sassmixin)
13-
- [#️⃣ caret-color(\$name, \$opacity) ⇒ Sass::Mixin](##%EF%B8%8F⃣-caret-colorname-opacity--sassmixin)
14-
- [#️⃣ border-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-colorname-opacity--sassmixin)
15-
- [#️⃣ border-left-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-left-colorname-opacity--sassmixin)
16-
- [#️⃣ border-right-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-right-colorname-opacity--sassmixin)
17-
- [#️⃣ border-top-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-top-colorname-opacity--sassmixin)
18-
- [#️⃣ border-bottom-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-bottom-colorname-opacity--sassmixin)
19-
- [#️⃣ border-block-start-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-block-start-colorname-opacity--sassmixin)
20-
- [#️⃣ border-block-end-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-block-end-colorname-opacity--sassmixin)
21-
- [#️⃣ border-inline-start-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-inline-start-colorname-opacity--sassmixin)
22-
- [#️⃣ border-inline-end-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-border-inline-end-colorname-opacity--sassmixin)
23-
- [#️⃣ outline-color(\$name, \$opacity) ⇒ Sass::Mixin](#%#%EF%B8%8F⃣-outline-colorname-opacity--sassmixin)
12+
- [#️⃣ text-emphasis-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-text-emphasis-colorname-opacity--sassmixin)
13+
- [#️⃣ caret-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-caret-colorname-opacity--sassmixin)
14+
- [#️⃣ border-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-colorname-opacity--sassmixin)
15+
- [#️⃣ border-left-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-left-colorname-opacity--sassmixin)
16+
- [#️⃣ border-right-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-right-colorname-opacity--sassmixin)
17+
- [#️⃣ border-top-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-top-colorname-opacity--sassmixin)
18+
- [#️⃣ border-bottom-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-bottom-colorname-opacity--sassmixin)
19+
- [#️⃣ border-block-start-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-block-start-colorname-opacity--sassmixin)
20+
- [#️⃣ border-block-end-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-block-end-colorname-opacity--sassmixin)
21+
- [#️⃣ border-inline-start-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-inline-start-colorname-opacity--sassmixin)
22+
- [#️⃣ border-inline-end-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-border-inline-end-colorname-opacity--sassmixin)
23+
- [#️⃣ outline-color(\$name, \$opacity) ⇒ Sass::Mixin](#%EF%B8%8F⃣-outline-colorname-opacity--sassmixin)
2424
- [ℹ️ **Examples**](#ℹ️-examples)
2525

2626
### 🎛️ **Functions**

docs/index.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
11
<p>
22
<img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/arvindcheenu/chromanomer?style=flat-square">
3-
<img alt="npm" src="https://img.shields.io/npm/v/chromanomer?color=cc3534&style=flat-square">
4-
<img alt="npm" src="https://img.shields.io/npm/dt/chromanomer?label=overall%20downloads&style=flat-square">
5-
<img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/min/chromanomer?label=npm%20bundle%20size&style=flat-square">
6-
<img alt="npm dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=0&color=brightgreen&style=flat-square">
7-
<img alt="NPM" src="https://img.shields.io/npm/l/chromanomer?style=flat-square">
3+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="npm" src="https://img.shields.io/npm/v/chromanomer?color=cc3534&style=flat-square"></a>
4+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/min/chromanomer?label=npm%20bundle%20size&style=flat-square"></a>
5+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="npm dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=0&color=brightgreen&style=flat-square"></a>
6+
<a href="https://www.npmjs.com/package/chromanomer"><img alt="NPM" src="https://img.shields.io/npm/l/chromanomer?style=flat-square"></a>
87
<br/>
98
</p>
109

10+
**Chromanomer** (abbreviated ***cono***) is a perceptually intuitive color naming system based on the ***Lightness Chroma Hue** color space* that covers a sizeable spectrum of colors while boasting a negligible learning curve.
11+
1112
![screenshot](https://raw.githubusercontent.com/arvindcheenu/Chromanomer/master/screenshots/no-command.png)
1213

1314
[![Installation and Usage](https://img.shields.io/badge/-Installation%20+%20usage-0144b7?style=for-the-badge&logo=PowerShell)](https://github.com/arvindcheenu/Chromanomer/blob/master/docs/INSTALL.md)
1415
[![Sass Styling Api](https://img.shields.io/badge/-Sass%20Styles-73264d?style=for-the-badge&logo=sass)](https://github.com/arvindcheenu/Chromanomer/blob/master/docs/STYLE.md)
1516
[![Node Api](https://img.shields.io/badge/-Node%20Api-435d0e?style=for-the-badge&logo=node.js)](https://github.com/arvindcheenu/Chromanomer/blob/master/docs/API.md)
1617
[![CommandLine Api](https://img.shields.io/badge/-CommandLine%20Api-1a1a1a?style=for-the-badge&logo=GNU%20Bash)](https://github.com/arvindcheenu/Chromanomer/blob/master/docs/CLI.md)
17-
18+
19+
20+
<a href="https://github.com/arvindcheenu">Made with ❤️ by <b>Arvind Srinivasan</b>.</a><br/>
21+
<b><small>Licensed Under <a href="https://github.com/arvindcheenu/Chromanomer/blob/master/LICENSE">Apache-2.0</a></small></b>.
22+
23+
---
24+
1825
### 🔑 Key Features
1926

2027
* 👁️ **Perceptually uniform** colours
@@ -41,8 +48,3 @@ For a more detailed look at an object applying this schema, please see the file
4148
Besides the above considerations while designing the schema, the following were also looked for:
4249
* The arrangement of terms according to increasing order of intensity in chroma and lightness while diverging from the base value of the schema (see *The Handle* in the above schema).
4350
* The arrangement of Warm and Cool Ranges according to the gradatation of hues from adjacent hue sectors.
44-
45-
46-
<a href="https://github.com/arvindcheenu">Made with ❤️ by <b>Arvind Srinivasan</b>.</a>
47-
<b><small>Licensed Under <a href="https://github.com/arvindcheenu/Chromanomer/blob/master/LICENSE">Apache-2.0</a></small></b>.
48-

0 commit comments

Comments
 (0)