janishutz/color-thief
1
0
Fork 0
mirror of https://github.com/janishutz/color-thief.git synced 2025-11-25 05:44:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Point readme readers to demo page

Browse Source
This commit is contained in:
Lokesh Dhakar
2019-08-22 21:28:48 -07:00
parent a0e9b772d9
commit 29e96fe72b
1 changed files with 3 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@@ -1,79 +1,7 @@
# Color Thief
A script for grabbing the color palette from an image. Works in browser and in Node.
Grab the color palette from an image using just Javascript. Works in the browser and in Node.
[See a Demo](http://lokeshdhakar.com/projects/color-thief) | [Read more on my blog](http://lokeshdhakar.com/color-thief)
## How to use Color Thief in Node
### Install and import
_Important: The name of the package is `colorthief`, not `color-thief`._
```console
npm i --save colorthief
```
```js
const ColorThief = require('colorthief');
```
### Get colors
Both `getColor` and `getPalette` return a `Promise` when used in Node.
```js
const img = resolve(process.cwd(), 'rainbow.png');
ColorThief.getColor(img)
.then(color => { console.log(color) })
.catch(err => { console.log(err) })
ColorThief.getPalette(img, 5)
.then(palette => { console.log(palette) })
.catch(err => { console.log(err) })
```
## How to use Color Thief in the Browser
### Install
_Important: The name of the package is `colorthief`, not `color-thief`._
```console
npm i --save colorthief
```
### Import and use as a global variable
```html
<script src="node_modules/colorthief/dist/color-thief.umd.js"></script>
<script>
const colorThief = new ColorThief();
const color = colorThief.getColor(document.querySelector('img'));
</script>
```
### Import and use as an ES6 module
_index.html_
```html
<script type="module" src="app.js"></script>
```
_app.js_
```js
import ColorThief from './node_modules/colorthief/dist/color-thief.mjs'
const colorThief = new ColorThief();
const result = colorThief.getColor(document.querySelector('img'));
```
### Import and use with RequireJS
The `/dist/color-thief.umd.js` file uses the UMD (Universal Module Definition) format. This includes RequireJS AMD support.
## API
_Note: Both `getColor` and `getPalette` return a `Promise` when used in Node._
| Method | Return | Description |
| --- | --- | --- |
| `getColor(image [, quality])` | `[Number, Number, Number]` | Gets the dominant color from the image. Color is returned as an array of three integers representing red, green, and blue values. |
| `getPalette(image [, colorCount, quality]` | `[[Number, Number, Number], ...]` | Gets a palette from the image by clustering similar colors. The palette is returned as an array containing colors, each color itself an array of three integers. |
- View the [demo page](https://lokeshdhakar.com/projects/color-thief/) for examples, API docs, and more.
- See [CONTRIBUTING.md](https://github.com/lokesh/color-thief/blob/master/CONTRIBUTING.md) for information useful for developers interesting in contributing to the project.