Permalink
Browse files

FIX: issue #9 - applying css attribs over img ruins the palette funct…

…ion. FIX: issue #3- update README regarding createPalette return val
  • Loading branch information...
1 parent 5cf0e60 commit 79d4c708382d3812229c84c8f9823b1deebb2de4 @lokesh lokesh committed Apr 23, 2012
Showing with 167 additions and 145 deletions.
  1. +22 −11 README.markdown
  2. +137 −126 css/app.css
  3. +4 −4 index.html
  4. +4 −4 js/color-thief.js
View
@@ -1,30 +1,41 @@
-# Color Thief
-A script for grabbing the dominant color or a representative color palette from an image. Uses javascript and canvas.
+#Color Thief
-###[See a Demo](http://lokeshdhakar.com/projects/color-thief)
+A script for grabbing the dominant color or color palette from an image. Uses javascript and canvas.
-###Usage
+[See a Demo](http://lokeshdhakar.com/projects/color-thief) | [Read more on my blog](http://lokeshdhakar.com/color-thief)
-####Get Dominant Color
+##Usage
+
+###Get Dominant Color
```js
getDominantColor(sourceImage)
```
-returns {r: num, g: num, b: num}
+
+```js
+returns [num, num, num]
+```
Uses the median cut algorithm provided by quantize.js to cluster similar
colors and return the base color from the largest cluster.
-####Create Palette
+###Create Palette
```js
createPalette(sourceImage, colorCount)
+```
+```js
+returns [ [num, num, num], [num, num, num], ... ]
```
-returns array[ {r: num, g: num, b: num}, {r: num, g: num, b: num}, ...]
Use the median cut algorithm provided by quantize.js to cluster similar
colors.
-BUGGY: Function does not always return the requested amount of colors. It can be +/- 2.
+##License
+by Lokesh Dhakar | [lokeshdhakar.com](http://www.lokeshdhakar.com) | [twitter.com/lokeshdhakar](http://twitter.com/lokeshdhakar)
+
+Thanks to [jfsiii](https://github.com/jfsiii) for a large number of code improvements and other for submitting issues and fixes.
+
+Licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/)
-###License
-Licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/)
+* Free for use in both personal and commercial projects.
+* Attribution requires leaving author name, author homepage link, and the license info intact.
Oops, something went wrong.

0 comments on commit 79d4c70

Please sign in to comment.