README.md

2024-08-10 13:27:13 +02:00 · 2024-08-10 13:27:13 +02:00 · ece216e6f4
commit ece216e6f4
parent 96725dc9c8
1 changed files with 47 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,47 @@
+`dd-gz` - dd compressing on the fly 
+
+## Create backup:
+
+```
+dd-gz backup /dev/<device> /path/<output>.gz
+```
+
+Example:
+
+```
+dd-gz backup /dev/sdc /home/backup/sdc-backup.gz
+```
+
+## Restore backup:
+
+```                                                                                                                                                                                                                  
+dd-gz restore /path/<input>.gz /dev/<device>                                                                                                                                                                       
+```  
+
+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
+