Skip to content

Commit

Permalink
update Installation instructions (#10)
Browse files Browse the repository at this point in the history
* update Installation instructions

* Update README.md
agrimrules authored Jul 21, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 55e794e commit 72ad192
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -15,6 +15,17 @@ A simple CLI tool written to verify files based on various hashing algorithms.
## Installation
Hashmatch is cross platform and available on Linux, macOS and Windows.

* Install on macOS via [Homebrew](https://brew.sh/)
```shell
brew install agrimrules/hashmatch/hashmatch
```

* Install on Windows via [Scoop](https://scoop.sh/)
```shell
scoop bucket add agrimrules https://github.com/agrimrules/scoop-bucket.git
scoop install agrimrules/hashmatch
```

* Install via the golang toolchain
```shell
go get -u github.com/agrimrules/hashmatch
@@ -37,6 +48,11 @@ hashmatch /path/to/directory1 /path/to/directory2
```
Will traverse both directories and indicate if all files within them match or not.

```shell
hashmatch file1 -o json
```
The `-o` flag can be used to output the results in JSON format

## License

The Hashmatch cli tool is open-sourced software licensed under the [Apache-2.0 License](./LICENSE).
@@ -48,4 +64,4 @@ The following projects had particular influence on the hashmatch cli.
- [karrick/godirwalk](https://github.com/karrick/godirwalk) helped provide quick directory traversal using a simpler API.
- [olekukonko/tablewriter](https://github.com/olekukonko/tablewriter) Provides a simple table TUI for displaying the results of the comparison.
- [spf13/cobra](https://github.com/spf13/cobra) A Go framework for building CLI applications.
- [thoas/go-funk](https://github.com/thoas/go-funk) A Go library providing functional utilities similar to lodash.
- [thoas/go-funk](https://github.com/thoas/go-funk) A Go library providing functional utilities similar to lodash.

0 comments on commit 72ad192

Please sign in to comment.