Skip to content

Commit

Permalink
Changed motivation description in README.mds.
Browse files Browse the repository at this point in the history
  • Loading branch information
ventaquil committed Dec 21, 2023
1 parent e638471 commit 3689939
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .cargo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
[![GitHub](https://img.shields.io/badge/github-chksum--rs%2Fcli-24292e?style=flat-square&logo=github "GitHub")](https://github.com/chksum-rs/cli)
[![Build](https://img.shields.io/github/actions/workflow/status/chksum-rs/cli/rust.yml?branch=master&style=flat-square&logo=github "Build")](https://github.com/chksum-rs/cli/actions/workflows/rust.yml)
[![MSRV](https://img.shields.io/badge/MSRV-1.70.0-informational?style=flat-square "MSRV")](https://github.com/chksum-rs/cli/blob/master/Cargo.toml)
[![deps.rs](https://deps.rs/crate/chksum/0.4.0/status.svg?style=flat-square "deps.rs")](https://deps.rs/crate/chksum/0.4.0)
[![deps.rs](https://deps.rs/crate/chksum/0.4.1/status.svg?style=flat-square "deps.rs")](https://deps.rs/crate/chksum/0.4.1)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square "unsafe forbidden")](https://github.com/rust-secure-code/safety-dance)
[![LICENSE](https://img.shields.io/github/license/chksum-rs/cli?style=flat-square "LICENSE")](https://github.com/chksum-rs/cli/blob/master/LICENSE)

A simple checksum calculator.

## Motivation

Various tools like `md5sum`, `sha1sum`, `b2sum`, `sha224sum`, etc., allow users to calculate file-based hash digests. However, these tools focus on file-level checksums, making it cumbersome to handle scenarios like calculating digests on-the-fly while writing data. This motivated the creation of `chksum` to offer a simplified interface for such use cases.
Various tools like `md5sum`, `sha1sum`, `b2sum`, `sha224sum`, etc., allow users to calculate file-based hash digests. However, these tools focus on file-level checksums, making it cumbersome to handle scenarios like calculating digests of whole directories. This motivated the creation of `chksum` to offer a simplified interface for such use cases.

```shell
find dir/ -type f | sort | xargs cat | sha224sum
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.4.1] - 2023-12-21

### Fixed

- Changed motivation description in `README.md`s.

## [0.4.0] - 2023-12-21

### Changed
Expand Down Expand Up @@ -66,6 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Initial release.

[0.4.1]: https://github.com/chksum-rs/cli/compare/v0.4.0...v0.4.1
[0.4.0]: https://github.com/chksum-rs/cli/compare/v0.3.2...v0.4.0
[0.3.2]: https://github.com/chksum-rs/cli/compare/v0.3.1...v0.3.2
[0.3.2]: https://github.com/chksum-rs/cli/compare/v0.3.1...v0.3.2
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "chksum-cli"
version = "0.4.0"
version = "0.4.1"
authors = ["Konrad Goławski <[email protected]>"]
edition = "2021"
rust-version = "1.70.0"
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
[![crates.io](https://img.shields.io/crates/v/chksum-cli?style=flat-square&logo=rust "crates.io")](https://crates.io/crates/chksum-cli)
[![Build](https://img.shields.io/github/actions/workflow/status/chksum-rs/cli/rust.yml?branch=master&style=flat-square&logo=github "Build")](https://github.com/chksum-rs/cli/actions/workflows/rust.yml)
[![MSRV](https://img.shields.io/badge/MSRV-1.70.0-informational?style=flat-square "MSRV")](https://github.com/chksum-rs/cli/blob/master/Cargo.toml)
[![deps.rs](https://deps.rs/crate/chksum/0.4.0/status.svg?style=flat-square "deps.rs")](https://deps.rs/crate/chksum/0.4.0)
[![deps.rs](https://deps.rs/crate/chksum/0.4.1/status.svg?style=flat-square "deps.rs")](https://deps.rs/crate/chksum/0.4.1)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square "unsafe forbidden")](https://github.com/rust-secure-code/safety-dance)
[![LICENSE](https://img.shields.io/github/license/chksum-rs/cli?style=flat-square "LICENSE")](https://github.com/chksum-rs/cli/blob/master/LICENSE)

A simple checksum calculator.

## Motivation

Various tools like `md5sum`, `sha1sum`, `b2sum`, `sha224sum`, etc., allow users to calculate file-based hash digests. However, these tools focus on file-level checksums, making it cumbersome to handle scenarios like calculating digests on-the-fly while writing data. This motivated the creation of `chksum` to offer a simplified interface for such use cases.
Various tools like `md5sum`, `sha1sum`, `b2sum`, `sha224sum`, etc., allow users to calculate file-based hash digests. However, these tools focus on file-level checksums, making it cumbersome to handle scenarios like calculating digests of whole directories. This motivated the creation of `chksum` to offer a simplified interface for such use cases.

```shell
find dir/ -type f | sort | xargs cat | sha224sum
Expand Down

0 comments on commit 3689939

Please sign in to comment.