Merge pull request #23 from NimaSoroush/update-readme

Update Readme and bug fixes

Author: danrr

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.0.13] - 2017-07-25
+### Added
+- Updating readme file
+- Bug fixes
+
 ## [0.0.12] - 2017-07-24
 ### Added
 - Added wait functionality

README.md

@@ -1,4 +1,4 @@
-<p align="center"><img alt="Differencify" src="http://i.imgur.com/D0Eapjx.png" width="150">
+<p align="center"><img alt="Differencify" src="images/logo.png" width="150">
 <br>
 <strong>Differencify</strong>
 <br>
@@ -9,8 +9,12 @@ Regression Testing suite!
 Status: [![CircleCI](https://circleci.com/gh/NimaSoroush/differencify/tree/master.svg?style=svg)](https://circleci.com/gh/NimaSoroush/differencify/tree/master)
 
 ## About
+Differencify is a library for visual regression testing by comparing your local changes with reference screenshots of your website.
+
+|Reference|Local changes|
+|---------|-------------|
+|<img alt="Differencify" src="images/reference_screenshot.png" width="400">|<img alt="Differencify" src="images/differencified_screenshot.png" width="400">|
 
-Differencify is library for visual regression testing by comparing your local changes with reference screenshots of your website.
 
 ## Requirements
 - Node > 6
@@ -33,13 +37,20 @@ async () => {
   console.log(result); //true if update succeeded
 }
 ```
+<p align="center">
+<img src="images/update.gif" width="500">
+</p>
+
 ### Validate your changes
 ```js
 async () => {
   const result = await differencify.test(TestOptions);
   console.log(result); //true if test pass
 }
 ```
+<p align="center">
+<img src="images/test.gif" width="500">
+</p>
 
 ### API
 

images/differencified_screenshot.png

@@ -24,7 +24,7 @@ const compareImage = async (options, testName) => {
 
   const distance = Jimp.distance(referenceImage, testImage);
   const diff = Jimp.diff(referenceImage, testImage, options.mismatchThreshold);
-  if (distance < options.mismatchThreshold || diff.percent < options.mismatchThreshold) {
+  if (distance < options.mismatchThreshold && diff.percent < options.mismatchThreshold) {
     return 'no mismatch found ✅';
   }
 

images/logo.png

@@ -59,18 +59,36 @@ describe('Compare Image', () => {
     expect(result).toEqual('no mismatch found ✅');
   });
 
-  it('returns correct value if only difference above threshold', async () => {
+  it('returns mismatch found❗ if only difference above threshold', async () => {
+    expect.assertions(1);
     Jimp.diff.mockReturnValue({ percent: 0.02 });
 
-    const result = await compareImage(mockConfig, 'test');
-    expect(result).toEqual('no mismatch found ✅');
+    try {
+      await compareImage(mockConfig, 'test');
+    } catch (err) {
+      expect(err.message).toEqual(`mismatch found❗
+    Result:
+      distance: 0
+      diff: 0.02
+      misMatchThreshold: 0.01
+  `);
+    }
   });
 
-  it('returns correct value if only distance above threshold', async () => {
+  it('returns mismatch found❗ if only distance above threshold', async () => {
+    expect.assertions(1);
     Jimp.distance.mockReturnValue(0.02);
 
-    const result = await compareImage(mockConfig, 'test');
-    expect(result).toEqual('no mismatch found ✅');
+    try {
+      await compareImage(mockConfig, 'test');
+    } catch (err) {
+      expect(err.message).toEqual(`mismatch found❗
+    Result:
+      distance: 0.02
+      diff: 0
+      misMatchThreshold: 0.01
+  `);
+    }
   });
 
   it('throws error if distance and difference are above threshold', async () => {