diff --git a/README.md b/README.md index feaf404..88ab2c8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Git Repository Synchronizer is a system that provides individuals the ability to GRS creates snapshots when it detects the source repository has been tampered with. -Tampering is detected when the source git repository reduces in size by a certain threshold. The threshold can be set by modifying `thresholdFactor` in `grs.sh`. Setting `thresholdFactor=5` would mean that the source git repository would have to drop by 20% for it to be considered as tampering. The way 20% is derived from a `thresholdFactor` of `5` is by dividing `1` by `thresholdFactor`. I the case where `thresholdFactor=5`; you would divide `1` by `5` resulting in `0.2` which is the ratio for 20%. +Tampering is detected when the source git repository reduces in size by a certain threshold. The threshold can be set by modifying `thresholdFactor` in `grs.sh`. Setting `thresholdFactor=5` would mean that the source git repository would have to drop by 20% for it to be considered as tampering. The way 20% is derived from a `thresholdFactor` of `5` is by dividing `1` by `thresholdFactor`. In the case where `thresholdFactor=5`; you would divide `1` by `5` resulting in `0.2` which is the ratio for 20%. The execution cycle can be set by configuring `timer.service` using systemd conventions. The settings default to executing every ten minutes on the hour.