Browse Source

updated README

pull/6/merge
James Cryer 12 years ago
parent
commit
81ff7adb71
  1. 47
      README.md

47
README.md

@ -1,4 +1,49 @@
Resemble.js
==========
Analyse and compare images with Javascript and HTML5. [Resemble.js Demo](http://huddle.github.com/Resemble.js/)
Analyse and compare images with Javascript and HTML5. [Resemble.js Demo](http://huddle.github.com/Resemble.js/)
### Example
Retrieve basic analysis on image.
```javascript
var api = resemble(fileData).onComplete(function(data){
console.log(data);
/*
{
red: 255,
green: 255,
blue: 255,
brightness: 255
}
*/
});
```
Use resemble to compare two images.
```javascript
var diff = resemble(file).compareTo(file2).ignoreColors().onComplete(function(data){
console.log(data);
/*
{
misMatchPercentage : 100, // %
isSameDimensions: true, // or false
getImageDataUrl: function(){}
}
*/
});
```
You can also change the comparison method after the first analysis.
```javascript
// diff.ignoreNothing();
// diff.ignoreColors();
diff.ignoreAntialiasing();
```
--------------------------------------
Created by [James Cryer](http://github.com/jamescryer) and the Huddle development team.
Loading…
Cancel
Save