Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
laktak committed Jan 1, 2025
1 parent 30b1a27 commit 554ddc9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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")

Expand Down
2 changes: 1 addition & 1 deletion cmd/chkbit/help.go
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 554ddc9

Please sign in to comment.