color-name-list 13.13.1 → 13.15.0

package/README.md

@@ -13,7 +13,7 @@
 [![npm](https://img.shields.io/npm/dt/color-name-list.svg)](https://www.npmjs.com/package/color-name-list)
 [![github sponsor count](https://img.shields.io/github/sponsors/meodai)](https://github.com/sponsors/meodai)
 
-A meticulously curated collection of __29985__ unique color names, sourced from
+A meticulously curated collection of __29987__ unique color names, sourced from
 [various references](#sources-) and thousands of thoughtful user contributions.
 
 > The names of color function like a thread attached to a frightfully slender
@@ -27,7 +27,6 @@ A meticulously curated collection of __29985__ unique color names, sourced from
   | <a href="#usage-">Usage</a>
   | <a href="#cdn-">CDN</a>
   | <a href="#api-">Public Rest API</a>
-  | <a href="#usage-js-">Usage JS/Java/Kotlin/C#</a>
   | <a href="#sources-">Name Sources</a>
   | <a href="#latest-color-names-">Latest Color Names</a>
   | <a href="#costs--sponsors">Sponsors</a>
@@ -75,7 +74,7 @@ CI notes:
 - No need to run `npm run build` locally; CI generates outputs.
 - Optional locally: `npm run lint:markdown` to match CI markdown checks.
 
-## Color Count: __29985__ 🎉
+## Color Count: __29987__ 🎉
 
 ~__0.18%__ of the RGB color space
 
@@ -91,23 +90,22 @@ color space: [Visualization](https://codepen.io/meodai/full/zdgXJj/)
 
 ## Usage 📖
 
+### Docs
+
+While the tooling and list are primarily in JavaScript/TypeScript, there are several
+other implementations maintained by the community:
+
+- JS/TS: [docs/usage-js.md](docs/usage-js.md)
+- Java/Kotlin: [docs/usage-java-kotlin.md](docs/usage-java-kotlin.md)
+- C#: [docs/usage-csharp.md](docs/usage-csharp.md)
+- Rust: [docs/usage-rust.md](docs/usage-rust.md)
+
 ### Consuming the list
 
 The list is available in [multiple formats](https://app.unpkg.com/color-name-list/files/dist),
 or you can use the [public REST API](#api-), making it easy to integrate into
 your project.
 
-### Node.js Installation 📦
-
-__Size Warning (1.14 MB)__: For browser usage,
-consider the [public rest API](#api-)
-
-```shell
-npm install color-name-list --save
-```
-
-or `yarn add color-name-list`
-
 ### CDN 🌍
 
 #### All Names 📚
@@ -133,6 +131,22 @@ or `yarn add color-name-list`
 / [SCSS](https://unpkg.com/color-name-list/dist/colornames.bestof.scss)
 / [CSS](https://unpkg.com/color-name-list/dist/colornames.bestof.css)
 
+### Usage JS 📦
+
+__Size Warning (1.14 MB)__: For browser usage,
+consider the [public rest API](#api-).
+
+Minimal example:
+
+```javascript
+import { colornames } from 'color-name-list';
+
+const white = colornames.find((c) => c.hex === '#ffffff');
+console.log(white?.name); // => white
+```
+
+More examples: see `docs/usage-js.md`.
+
 ### API 🃏
 
 To simplify access, we provide a free and public REST API for all color names
@@ -153,63 +167,6 @@ generates excessive traffic, you may be asked to become a sponsor.
 You are welcome to self-host the API—it's easy to deploy on Heroku and relies
 only on a few dependencies: [Color-Name-API](https://github.com/meodai/color-name-api)
 
-### Usage JS ⌨
-
-__Size Warning (1.14 MB)__: For browser usage,
-consider the [public rest API](#api-)
-
-#### Data Shape
-
-```ts
-type ColorName = { name: string; hex: string };
-```
-
-#### Exact Color
-
-```javascript
-import { colornames } from 'color-name-list';
-
-let someColor = colornames.find((color) => color.hex === '#ffffff');
-console.log(someColor.name); // => white
-
-let someNamedColor = colornames.find((color) => color.name === 'Eigengrau');
-console.log(someColor.hex); // => #16161d
-```
-
-#### CommonJS
-
-```js
-// Returns the array directly when using CommonJS
-const colornames = require('color-name-list');
-
-const white = colornames.find((c) => c.hex === '#ffffff');
-console.log(white.name); // => white
-```
-
-#### Closest Named Color
-
-With 16,777,216 possible RGB colors, you may want to use a library such as
-[nearest-color] or [ClosestVector] to find the closest named color.
-
-```js
-import nearestColor from 'nearest-color';
-import { colornames } from 'color-name-list';
-
-// nearestColor expects an object {name => hex}
-const colors = colornames.reduce((o, { name, hex }) => Object.assign(o, { [name]: hex }), {});
-
-const nearest = nearestColor.from(colors);
-
-// get closest named color
-nearest('#f1c1d1'); // => Fairy Tale
-```
-
-__Note__: For greater visual accuracy, consider using [DeltaE] or the above
-approach with [ciecam02] instead of RGB.
-
-[DeltaE]: https://github.com/zschuessler/DeltaE
-[ciecam02]: https://github.com/baskerville/ciecam02
-
 ### Building 🔨
 
 ```shell
@@ -218,145 +175,11 @@ npm install && npm run build
 
 See [package.json](package.json#L6) for details.
 
-### Usage Java/Kotlin ⌨
-
-Java/Kotlin support is provided by:
-[UwUAroze/Color-Names](https://github.com/UwUAroze/Color-Names).
-See the repository for more, or use the basics below:
-
-#### Importing - Gradle.kts
-
-```kts
-repositories {
-      maven("https://jitpack.io")
-}
-
-dependencies {
-      implementation("me.aroze:color-names:1.0.4")
-}
-```
-
-#### Importing - Maven
-
-```xml
-<repository>
-  <id>jitpack.io</id>
-  <url>https://jitpack.io</url>
-</repository>
-
-<dependency>
-  <groupId>me.aroze</groupId>
-  <artifactId>color-names</artifactId>
-  <version>1.0.4</version>
-</dependency>
-```
-
-#### Closest named color - Java
-
-```java
-public ColorNames colorNames = new ColorNameBuilder()
-  .loadDefaults()
-  .build();
-
-String fromHex = colorNames.getName("#facfea"); // "Classic Rose"
-String fromRGB = colorNames.getName(224, 224, 255); // "Stoic White"
-String fromColor = colorNames.getName(new Color(255, 219, 240)); // "Silky Pink"
-```
-
-#### Closest named color - Kotlin
-
-```kt
-val colorNames = ColorNameBuilder()
-  .loadDefaults()
-  .build()
-
-val fromHex = colorNames.getName("#facfea") // "Classic Rose"
-val fromRGB = colorNames.getName(224, 224, 255) // "Stoic White"
-val fromColor = colorNames.getName(Color(255, 219, 240)) // "Silky Pink"
-```
-
-### Usage C# ⌨
-
-C# support is provided by:
-[vycdev/ColorNamesSharp](https://github.com/vycdev/ColorNamesSharp)
-See the repository for more details; basic usage is below:
-
-The library is available as a [nuget package](https://www.nuget.org/packages/ColorNamesSharp)
-
-#### Creating the instance
-
-```csharp
-ColorNames colorNames = new ColorNamesBuilder()
-  .Add("Best Blue", "#3299fe") // Add your own custom colors
-  .LoadDefault() // Load the default color list
-  .AddFromCsv("path/to/your/colorlist.csv") // Add a custom color list from a csv file
-  .Build(); // Get a new ColorNames instance that includes all the colors you've added
-```
-
-#### Getting a fitting color name
-
-```csharp
-NamedColor customNamedColor = new("Custom Named Color", 50, 153, 254);
-
-// You can directly get the name of the color as a string
-string colorNameFromHex = colorNames.FindClosestColorName("#facfea"); // Classic Rose
-string colorNameFromRgb = colorNames.FindClosestColorName(224, 224, 255); // Stoic White
-string colorNameFromNamedColor = colorNames.FindClosestColorName(customNamedColor); // Best Blue
-
-// Or similarly you can get the NamedColor object
-NamedColor namedColorFromHex = colorNames.FindClosestColorName("#facfea"); // Classic Rose
-NamedColor namedColorFromRgb = colorNames.FindClosestColorName(224, 224, 255); // Stoic White
-NamedColor namedColorFromNamedColor = colorNames.FindClosestColorName(customNamedColor); // Best Blue
-
-// Or a random color
-NamedColor randomColor = colorNames.GetRandomNamedColor();
-```
-
-### Usage Rust
-
-Rust support is provided by
-[philocalyst/color-names](https://github.com/philocalyst/color-names).
-You can add it to your rust project with `cargo add colorsnamed`. See the
-repository for more details. Basic usage is below.
-
-#### Choosing colors
-
-```rust
-use colorsnamed;
-
-let black = colorsnamed::Basic::Black;
-let teal = colorsnamed::Basic::Teal;
-let another = colorsnamed::Xkcd::Tea;
-```
-
-#### Getting colors
-
-```rust
-use colorsnamed;
-
-// Get the relevant hex code
-let red = colorsnamed::Basic::Red;
-let hex = red.hex();
-
-// Figure out if there is a matching color for a hex code!
-let ex: colorsnamed::Basic = hex.try_into().unwrap();
-```
-
-#### Converting colors
+### Java/Kotlin, C#, Rust
 
-```rust
-use colorsnamed;
-use colors;
-use rgb::Rgb;
-
-// Convert to the represention of your colorspace of choice.
-let correct_color = red.color::<colors::Srgb>();
-
-let red = colorsnamed::Basic::Red;
-
-// Get the RGB representation
-let rgb: Rgb = red.rgb();
-```
+- [docs/usage-java-kotlin.md](docs/usage-java-kotlin.md)
+- [docs/usage-csharp.md](docs/usage-csharp.md)
+- [docs/usage-rust.md](docs/usage-rust.md)
 
 ## Sources 🗒
 
@@ -493,11 +316,6 @@ so we can address them promptly.
 [Color Distribution]: https://codepen.io/meodai/full/zdgXJj/
 [Twitter Bot]: https://twitter.com/color_parrot
 
-<!-- 3r party libraries & tools -->
-
-[ClosestVector]: https://github.com/meodai/ClosestVector
-[nearest-color]: https://github.com/dtao/nearest-color
-
 <!-- people -->
 
 [Ichatdelune]: https://www.reddit.com/user/Ichatdelune

package/changes.svg

@@ -1,4 +1,4 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 600 570">
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 600 290">
   <defs>
     <style type="text/css">
       @import url('https://rsms.me/inter/inter.css');
@@ -9,6 +9,6 @@
       }
     </style>
   </defs>
-  <rect fill="#212121" x="0" y="0" width="600" height="570"/>
-  <text x="40" y="90" fill="#c8b960">Almond Puff</text><text x="40" y="160" fill="#5f1a10">Altar Wine</text><text x="40" y="230" fill="#83c0e5">Billow</text><text x="40" y="300" fill="#877732">Dragon Well</text><text x="40" y="370" fill="#363e7d">Evening Magic</text><text x="40" y="440" fill="#377b70">Pearl Green</text><text x="40" y="510" fill="#5e0e0b">Sacramental Red</text>
+  <rect fill="#212121" x="0" y="0" width="600" height="290"/>
+  <text x="40" y="90" fill="#b85824">Fallen Canopy</text><text x="40" y="160" fill="#22cc88">Magical Malachite</text><text x="40" y="230" fill="#e8c2b4">Mellow Marrow</text>
 </svg>

package/dist/colornames.bestof.csv

@@ -1318,6 +1318,7 @@ Fake Jade,#13eac9
 Fake Love,#cc77ee
 Falafel,#aa7711
 Fallen Blossoms,#edb2c4
+Fallen Canopy,#b85824
 Fallen Petals,#f2e0da
 Fanatic Fuchsia,#ee1199
 Fancy Fuchsia,#ff0088
@@ -2476,6 +2477,7 @@ Magic Carpet,#9488be
 Magic Ink,#0247fe
 Magic Magenta,#7f4774
 Magic Potion,#ff4466
+Magical Malachite,#22cc88
 Magical Merlin,#3d8ed0
 Magical Moonlight,#f0eeeb
 Magical Stardust,#eaeadb
@@ -2599,6 +2601,7 @@ Mellow Apricot,#f8b878
 Mellow Dandelion,#f8de7f
 Mellow Drama,#ffc65f
 Mellow Mango,#cc4400
+Mellow Marrow,#e8c2b4
 Mellow Melon,#ee2266
 Mellow Mint,#ddedbd
 Melodramatic Magenta,#dd22aa