colorkind - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "colorkind",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "colorblind-friendly color palettes",
-  "main": "dist/index.js",
   "author": "Chris Bolin",
   "license": "MIT",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "node scripts/build.js",
+    "stats": "node scripts/stats.js"
+  },
   "files": [
@@ -12,3 +16,6 @@ "dist/"
   "private": false,
-  "sideEffects": false
+  "sideEffects": false,
+  "devDependencies": {
+    "package-build-stats": "^6.2.2"
+  }
 }

README.md

 # colorkind
 
 _Simple, colorblind-friendly color palettes for data visualization._
+
+[![npm size](https://badges.formidable.com/size/npm/colorkind/dist/index.js?gzip=true)](https://www.runpkg.com/?colorkind)
+[![npm version](https://badge.fury.io/js/colorkind.svg)](https://www.npmjs.com/package/colorkind)
+
+## Usage
+
+Colorkind exports a default pallette of 7 colors (Paul Tol's 'bright' pallette). You can also choose the number of colors you need, between 2 and 12, or by pallette name. Colorkind is designed to be _very_ light, just exporting the colors themselves; hence, each pallette is a separate import.
+
+```js
+const pallette = require("colorkind"); // ["#4477AA", "#EE6677", ... ] default 7-color pallette
+// import by number of colors
+const pallette = require("colorkind/2"); // [ "#004488", "#DDAA33" ] 2-color pallette
+const pallette = require("colorkind/12"); // [ "#332288", "#117733", ... ] 12-color pallette
+// import by pallette name
+const pallette = require("colorkind/tol-light"); // [ "#77AADD", "#EE8866", ... ] Paul Tol's 'light' pallette
+```
+
+## Available pallettes
+
+| Import path                         | Colors | Description                         |
+| ----------------------------------- | ------ | ----------------------------------- |
+| `colorkind`                         | 7      | Paul Tol's 'bright' theme           |
+| `colorkind/2`                       | 2      | Paul Tol's 'high contrast' theme    |
+| `colorkind/3`                       | 3      | Paul Tol's 'high contrast' theme    |
+| `colorkind/4`                       | 4      | Paul Tol's 'bright' theme           |
+| `colorkind/5`                       | 5      | Paul Tol's 'bright' theme           |
+| `colorkind/6`                       | 6      | Paul Tol's 'bright' theme           |
+| `colorkind/7`                       | 7      | Paul Tol's 'bright' theme           |
+| `colorkind/8`                       | 8      | Paul Tol's 'light' theme            |
+| `colorkind/9`                       | 9      | Paul Tol's 'light' theme            |
+| `colorkind/10`                      | 10     | Paul Tol's 'muted' theme            |
+| `colorkind/11`                      | 11     | Paul Tol's legacy qualitative theme |
+| `colorkind/12`                      | 12     | Paul Tol's legacy qualitative theme |
+| `colorkind/tol-high-contrast`       | 3      | Paul Tol's 'high contrast' theme    |
+| `colorkind/tol-bright`              | 7      | Paul Tol's 'bright' theme           |
+| `colorkind/tol-light`               | 9      | Paul Tol's 'light' theme            |
+| `colorkind/tol-muted`               | 10     | Paul Tol's 'muted' theme            |
+| `colorkind/tol-legacy`              | 12     | Paul Tol's legacy qualitative theme |
+| `colorkind/tol-discrete-rainbow/2`  | 2      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/3`  | 3      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/4`  | 4      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/5`  | 5      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/6`  | 6      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/7`  | 7      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/8`  | 8      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/9`  | 9      | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/10` | 10     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/11` | 11     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/12` | 12     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/13` | 13     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/14` | 14     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/15` | 15     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/16` | 16     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/17` | 17     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/18` | 18     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/19` | 19     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/20` | 20     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/21` | 21     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/22` | 22     | Paul Tol's 'discrete rainbow' theme |
+| `colorkind/tol-discrete-rainbow/23` | 23     | Paul Tol's 'discrete rainbow' theme |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12119

increased by91.97%

Number of package files

42

increased by2.44%

Number of lines in readme file

64

increased by1500%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes