Add README.md

This commit is contained in:
Mohammed Goder 2024-03-13 10:54:29 -05:00
parent a7b7ab9957
commit e1e8032b2b

7
README.md Normal file
View File

@ -0,0 +1,7 @@
Git Repository Synchronizer v1 is a system that provides individuals the ability to archive a git repository without having to worry about the archive being sabotaged.
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/thresholdFactor` which in the case of `1/5` would equal `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.