playground
/
Resemble.js
mirror of https://github.com/Huddle/Resemble.js.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

Merge pull request #96 from dx-pbuckley/minor-typo-and-consistent-colons 

minor typo and consistent colons for example text
pull/97/head
James Cryer 8 years ago committed by GitHub
parent
405febb759 70fc1081da
commit
f81d673a1f
1 changed files with 5 additions and 5 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      README.md

10
README.md
Unescape View File

@ -13,7 +13,7 @@ Analyse and compare images with Javascript and HTML5. [More info & Resemble.js D
### Example ### Example
Retrieve basic analysis on image. Retrieve basic analysis on an image:
```javascript ```javascript
var api = resemble(fileData).onComplete(function(data){ var api = resemble(fileData).onComplete(function(data){
@ -29,7 +29,7 @@ var api = resemble(fileData).onComplete(function(data){
}); });
``` ```
Use resemble to compare two images. Use resemble to compare two images:
```javascript ```javascript
var diff = resemble(file).compareTo(file2).ignoreColors().onComplete(function(data){ var diff = resemble(file).compareTo(file2).ignoreColors().onComplete(function(data){
@ -51,7 +51,7 @@ Scale second image to dimensions of the first one:
diff.scaleToSameSize(); diff.scaleToSameSize();
``` ```
You can also change the comparison method after the first analysis. You can also change the comparison method after the first analysis:
```javascript ```javascript
// diff.ignoreNothing(); // diff.ignoreNothing();
@ -60,7 +60,7 @@ diff.ignoreAntialiasing();
``` ```
And change the output display style. And change the output display style:
```javascript ```javascript
resemble.outputSettings({ resemble.outputSettings({
@ -79,7 +79,7 @@ resemble.outputSettings({
By default, the comparison algorithm skips pixels when the image width or height is larger than 1200 pixels. This is there to mitigate performance issues. By default, the comparison algorithm skips pixels when the image width or height is larger than 1200 pixels. This is there to mitigate performance issues.
You can switch this modify this behaviour by setting the `largeImageThreshold` option to a different value. Set it to **0** to switch it off completely. You can modify this behaviour by setting the `largeImageThreshold` option to a different value. Set it to **0** to switch it off completely.
`useCrossOrigin` is true by default, you might need to set it to false if you're using [Data URIs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs). `useCrossOrigin` is true by default, you might need to set it to false if you're using [Data URIs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs).

Write Preview
Loading…
Cancel
Save