Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .eslintignore

This file was deleted.

4 changes: 0 additions & 4 deletions .eslintrc.js

This file was deleted.

8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build Status](https://travis-ci.org/gemini-testing/looks-same.svg?branch=master)](https://travis-ci.org/gemini-testing/looks-same)

Node.js library for comparing images, taking into account human color
Pure node.js library for comparing png images, taking into account human color
perception. It is created specially for the needs of visual regression testing
for [`testplane`](http://github.com/gemini-testing/testplane) utility, but can be used
for other purposes.
Expand All @@ -14,12 +14,6 @@ Benchmark is presented in the corresponding directory.
- [Benchmark description](./benchmark/README.md)
- [Benchmark results](./benchmark/results.md)

## Supported image formats

JPEG, PNG, WebP, GIF, AVIF, TIFF and SVG images are supported.

*Note: If you want to compare jpeg files, you may encounter random differences due to the jpeg structure if they are not lossless jpeg files.*

Comment on lines -17 to -22
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Breaking change

## Comparing images

```javascript
Expand Down
2 changes: 1 addition & 1 deletion benchmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ See [**results.md**](./results.md) for execution times across all test cases.
```
3. Install dependencies:
```bash
npm ci
npm install
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed package-lock because otherwise we would need to update it every time when looks-same package.json is updated

```
4. Run the benchmark:
```bash
Expand Down
Loading