color-name-list 10.28.1 → 11.1.0

package/.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [15.x, 16.x]
+        node-version: [20.x]
 
     steps:
     - uses: actions/checkout@v2

package/.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 19
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: Test

package/.husky/pre-commit

@@ -0,0 +1 @@
+npm test && npm run build

package/README.md

@@ -23,7 +23,7 @@ A handpicked list of __30242__ unique color names 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</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>
@@ -135,12 +135,12 @@ consider using the [public rest API](#api-)
 #### Exact Color
 
 ```javascript
-import { colorNameList } from 'color-name-list';
+import { colornames } from 'color-name-list';
 
-let someColor = colorNameList.find(color => color.hex === '#ffffff');
+let someColor = colornames.find(color => color.hex === '#ffffff');
 console.log(someColor.name); // => white
 
-let someNamedColor = colorNameList.find(color => color.name === 'Eigengrau')
+let someNamedColor = colornames.find(color => color.name === 'Eigengrau')
 console.log(someColor.hex); // => #16161d
 ```
 
@@ -151,10 +151,10 @@ Since there are 16777216 possible RGB colors, you might use a library such as
 
 ```js
 import nearestColor from 'nearest-color';
-import { colorNameList } from 'color-name-list';
+import { colornames } from 'color-name-list';
 
 // nearestColor need objects {name => hex} as input
-const colors = colorNameList.reduce((o, { name, hex }) => Object.assign(o, { [name]: hex }), {});
+const colors = colornames.reduce((o, { name, hex }) => Object.assign(o, { [name]: hex }), {});
 
 const nearest = nearestColor.from(colors);
 
@@ -233,6 +233,43 @@ val fromRGB = colorNames.getName(224, 224, 255) // "Stoic White"
 val fromColor = colorNames.getName(Color(255, 219, 240)) // "Silky Pink"
 ```
 
+### Usage C# ⌨
+
+C# usage is maintained through this library:
+[vycdev/ColorNamesSharp](https://github.com/vycdev/ColorNamesSharp)
+Additional info can be found there, but basic usage is outlined 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();
+```
+
 ## Sources 🗒
 
 ### Sources: Names 📇