From ece216e6f4c699563c884119b0eafd4bd1f971d9 Mon Sep 17 00:00:00 2001
From: q3aql <q3aql@duck.com>
Date: Sat, 10 Aug 2024 13:27:13 +0200
Subject: [PATCH] README.md

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

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/<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
+