Skip to content

Commit

Permalink
Update README according to recent changes
Browse files Browse the repository at this point in the history
Signed-off-by: Igor Shishkin <me@teran.ru>
  • Loading branch information
teran committed Dec 1, 2018
1 parent 8413d44 commit d2fc9cd
Showing 1 changed file with 22 additions and 33 deletions.
55 changes: 22 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,20 @@ checksum
Utility to store length, sha1, sha256 hashes of files in dedicated "database"(actually just a JSON file) to
verify it later as a part of consistency check with automatic new file indexing.

Why not shasum/md5sum/etc.?
---------------------------

checksum provides straight workflow for verification and adding new files processes
to avoid remembering someting like `find $dir | xargs md5sum >> /tmp/database.txt`.

checkum automatically:

* verifies files
* adds new
* report about fails and misses

How to install
--------------

macOS with Homebrew:

```bash
brew install https://raw.githubusercontent.com/teran/checksum/master/contrib/Homebrew/checksum.rb
```

or to upgrade:

```bash
brew upgrade https://raw.githubusercontent.com/teran/checksum/master/contrib/Homebrew/checksum.rb
```

Other distros:

just refer to releases page and download appropriate binary for your platform

Usage
-----

```man
Utility to verify files consistency with length, SHA1 and SHA256
Usage:
checksum-darwin-amd64 [FLAG]...
checksum [FLAG]...
Version:
version: 98029e9
version: 0.8.3
commit: 026c5147ec576226a108035b08e15f2f5618f507
built with: go1.11.2
built at: 2018-12-01T09:35:54Z
Description:
checksum creates database (actually just a JSON file) to store file length, SHA1, SHA256
Expand All @@ -69,6 +40,24 @@ Flags:
-h, --help show help
```


Why not shasum/md5sum/etc.?
---------------------------

checksum provides straight workflow for verification and adding new files processes
to avoid remembering someting like `find $dir | xargs md5sum >> /tmp/database.txt`.

checkum automatically:

* verifies files
* adds new
* report about fails and misses

How to install
--------------

Just refer to [releases page](https://github.com/teran/checksum/releases) and download appropriate binary for your platform or build your own one right from master.

Build
-----

Expand Down

0 comments on commit d2fc9cd

Please sign in to comment.