Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Strip Dependencies (fix Got vulnerability) #7

Merged
merged 2 commits into from
Oct 1, 2024
Merged

Strip Dependencies (fix Got vulnerability) #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1d695
update cli
mattdesl Sep 27, 2024
39e4ae8
4.0.0
mattdesl Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@

A JSON of the top color palettes on [ColourLovers.com](http://colourlovers.com/), as RGB hex strings.

###### *Last updated Oct 14 2018*
###### _Last updated Oct 14 2018_

![colors](visualize/1000.png)

## Example

```js
var colors = require('nice-color-palettes');
var colors = require("nice-color-palettes");

console.log(colors.length);
// => 100

console.log(colors[0]);
// => [ "#69d2e7", "#a7dbd8", "#e0e4cc", "#f38630", "#fa6900" ]
```
```

## Install

Expand All @@ -36,34 +36,37 @@ This also exposes two other sizes for convenience, 200 and 500:

```js
// top 100 palettes
require('nice-color-palettes');
require("nice-color-palettes");

// top 200 palettes
require('nice-color-palettes/200');
require("nice-color-palettes/200");

// top 500 palettes
require('nice-color-palettes/500');
require("nice-color-palettes/500");

// top 1000 palettes
require('nice-color-palettes/1000');
```
require("nice-color-palettes/1000");
```

*Note:* Duplicate palettes and palettes with less than 5 colors are filtered out for the sake of consistency, so you may end up with a slightly different number in the JSON, like 495 palettes instead of 500.
_Note:_ Duplicate palettes and palettes with less than 5 colors are filtered out for the sake of consistency, so you may end up with a slightly different number in the JSON, like 495 palettes instead of 500.

## CLI Usage

This also includes a CLI for fetching palettes, writing the JSON to stdout.
As of version 4.0, the CLI is no longer exposed as a primary dependency, but as a dev dependency that can be run locally when cloning the repo.

```sh
nice-color-palettes [count] [opts]
git clone https://github.com/Experience-Monks/nice-color-palettes.git
cd nice-color-palettes
npm install
node bin/index.js [count] [opts]

Options:
count number of palettes (default 100)
--pretty pretty-print the JSON

Examples:
nice-color-palettes 300 --pretty > top-300.json
nice-color-palettes > top-100.json
node bin/index.js 300 --pretty > top-300.json
node bin/index.js > top-100.json
```

## License
Expand Down
Loading