From 554ddc9c19489edae00093cda3bd563742659402 Mon Sep 17 00:00:00 2001 From: Christian Zangl Date: Wed, 1 Jan 2025 18:54:50 +0100 Subject: [PATCH] readme --- README.md | 7 ++++++- cmd/chkbit/help.go | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 960bdbe..55dacc8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # chkbit -chkbit alerts you of data corruption of your files, especially during transfers, backups and after recovery. It helps detect issues like disk damage, filesystem errors, and malware interference. +chkbit alerts you of data corruption in your files, especially during transfers, backups and after recovery. It helps detect issues like disk damage, filesystem errors, and malware interference. Some filesystems (like Btrfs and ZFS, but not APFS or NTFS) already protect your files with checksums. However when you move files between locations, separate checks have the advantage of confirming that the data was not modified during transit. So you know the photo on your disk is the same as the copy in your cloud backup. This also protects you from overwriting good data with bad copies. +## version 6 + +- chkbit adds a new `atom` mode to store all indices in a single file +- if you come from an old version please check out the new simplified CLI syntax + ![gif of chkbit](https://raw.githubusercontent.com/wiki/laktak/chkbit/readme/chkbit.gif "chkbit") diff --git a/cmd/chkbit/help.go b/cmd/chkbit/help.go index 38686bc..c8cef4b 100644 --- a/cmd/chkbit/help.go +++ b/cmd/chkbit/help.go @@ -1,6 +1,6 @@ package main -var headerHelp = `Alerts you of data corruption of your files, especially during transfers, backups and after recovery. +var headerHelp = `Alerts you of data corruption in your files, especially during transfers, backups and after recovery. For help tips run "chkbit -H" or go to https://github.com/laktak/chkbit