README.md | 12 ++++++------ diff --git a/README.md b/README.md index 46a6a0fdf373a3fd208eb1a6db97b23896acb125..c3ff63ec2fc0a70e7d25d3a3cf43cd64101fa812 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ Fast stateful file/disk data syncer. #### Description -The main purpose of this utility is fast data synchronizing between two -hard drives: one is fast (SSD, SATA HDD), another is connected through -slow USB interface. Task is to lower amounts of data needed to be -transferred. +The main purpose of this utility is fast data synchronization between +two hard drives: one is fast (SSD, SATA HDD), another is connected +through slow USB interface. Target is to lower data amounts needed to +be transferred. This utility is stateful: it keeps precomputed data hashes in separate -statefile and use it to determine if we need to update block of data. +statefile and uses it to determine if we need to update block of data. ``` # sync from very fast SSD to slow USB connected HDD @@ -53,7 +53,7 @@ ### Statefile Format `SRC_SIZE || BLK_SIZE || HASH0 || HASH1 || ...` -SRC_SIZE contains size of the source, when it was firstly read. BLK_SIZE +SRC_SIZE contains size of the source, when it was initially read. BLK_SIZE is the blocksize used. Both are 64-bit big-endian unsigned integers. If either size or blocksize differs, then syncer will deny using that statefile as a precaution. HASHx is BLAKE2b-512 hash output, 64 bytes.