diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac0f621 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +`dd-gz` - dd compressing on the fly + +## Create backup: + +``` +dd-gz backup /dev/ /path/.gz +``` + +Example: + +``` +dd-gz backup /dev/sdc /home/backup/sdc-backup.gz +``` + +## Restore backup: + +``` +dd-gz restore /path/.gz /dev/ +``` + +Example: + +``` +dd-gz restore /home/backup/sdc-backup.gz /dev/sdc +``` + +## How to install: + +``` +git clone https://git.q3aql.dev/q3aql/dd-gz +cd dd-gz +sudo make install +``` + +## How to uninstall: + +``` +git clone https://git.q3aql.dev/q3aql/dd-gz +cd dd-gz +sudo make uninstall +``` + +## Dependencies +* sh +* dd +* gzip +