Skip to content

Commit c050abe

Browse files
committed
docs: add how to install
1 parent 2981251 commit c050abe

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# imgdiff
22

3-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![CircleCI](https://circleci.com/gh/kemokemo/imgdiff.svg?style=svg)](https://circleci.com/gh/kemokemo/imgdiff)
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![test-and-build](https://github.com/kemokemo/imgdiff/actions/workflows/test-and-build.yml/badge.svg)](https://github.com/kemokemo/imgdiff/actions/workflows/test-and-build.yml)
44

55
This tool compares old and new versions of image files and generates color-coded image in a diff format.
66

@@ -11,6 +11,26 @@ Thanks to the wonderful [@murooka](https://github.com/murooka)'s [go-diff-image]
1111

1212
## Install
1313

14+
### Homebrew
15+
16+
```sh
17+
brew install kemokemo/tap/imgdiff
18+
```
19+
20+
### Scoop
21+
22+
First, add my scoop-bucket.
23+
24+
```sh
25+
scoop bucket add kemokemo-bucket https://github.com/kemokemo/scoop-bucket.git
26+
```
27+
28+
Next, install this app by running the following.
29+
30+
```sh
31+
scoop install imgdiff
32+
```
33+
1434
### Binary
1535

1636
Get the latest version from [the release page](https://github.com/kemokemo/imgdiff/releases/latest), and download the archive file for your operating system/architecture. Unpack the archive, and put the binary somewhere in your `$PATH`.
@@ -23,6 +43,7 @@ Usage: imgdiff [<option>...] <old image> <new image>
2343
-h display help
2444
-o string
2545
output filename (default "diff.png")
46+
-v display version
2647
```
2748

2849
This tool supports the following image formats.
@@ -40,7 +61,7 @@ $ imgdiff -o=diff/screen.png v1/screen.png v2/screen.png
4061

4162
## License
4263

43-
[MIT](https://github.com/kemokemo/imgdiff/blob/master/LICENSE)
64+
[MIT](https://github.com/kemokemo/imgdiff/blob/main/LICENSE)
4465

4566
## Author
4667

0 commit comments

Comments
 (0)