From 2bbcca525387f5446c263bb3de8028dcdf0f6887 Mon Sep 17 00:00:00 2001
From: ScuroNeko <nix1304@gmail.com>
Date: Fri, 17 Oct 2025 13:11:06 +0300
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f83886
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# ZsDiff
+
+A partial update program. Use [Zstandrard](https://github.com/facebook/zstd).
+
+`zsdiff` products a [filename].zdiff file. It compares ALL file hashes from old with new.
+
+```
+Usage: zsdiff [OPTIONS] --filename <FILENAME> --old <OLD> --new <NEW>
+
+Options:
+  -f, --filename <FILENAME>              
+  -c, --compress-level <COMPRESS_LEVEL>  [default: 11]
+  -o, --old <OLD>                        
+  -n, --new <NEW>                        
+  -h, --help                             Print help
+```
+
+`zspatch` extract files from [filename].zdiff to [dest-dir]. If some file was deleted between old and new, `zspatch`
+also delete it from [dest-dir]
+
+```
+Usage: zspatch [OPTIONS] --filename <FILENAME> --dest-dir <DEST_DIR>
+
+Options:
+  -f, --filename <FILENAME>  
+  -d, --dest-dir <DEST_DIR>  
+  -h, --hash-check           
+  -h, --help                 Print help
+```
\ No newline at end of file