init

1 files changed, 48 insertions, 0 deletions

diff --git a/.config/yazi/plugins/compress.yazi/README.md b/.config/yazi/plugins/compress.yazi/README.md
new file mode 100644
index 0000000..385fe38
--- /dev/null
+++ b/.config/yazi/plugins/compress.yazi/README.md
@@ -0,0 +1,48 @@
+# ~~archive.yazi~~ compress.yazi
+
+A Yazi plugin that compresses selected files to an archive. Supporting yazi versions 0.2.5 and up.
+
+## Supported file types
+
+| Extention     | Unix Command  | Windows Command |
+| ------------- | ------------- | --------------- |
+| .zip          | zip -r        | 7z a -tzip      |
+| .7z           | 7z a          | 7z a            |
+| .tar          | tar rpf       | tar rpf         |
+| .tar.gz       | gzip          | 7z a -tgzip     |
+| .tar.xz       | xz            | 7z a -txz       |
+| .tar.bz2      | bzip2         | 7z a -tbzip2    |
+| .tar.zst      | zstd          | zstd            |
+
+
+**NOTE:** Windows users are required to install 7-Zip and add 7z.exe to the `path` environment variable, only tar archives will be available otherwise.
+
+
+## Install
+
+```bash
+# For Unix platforms
+git clone https://github.com/KKV9/compress.yazi.git ~/.config/yazi/plugins/compress.yazi
+
+## For Windows
+git clone https://github.com/KKV9/compress.yazi.git %AppData%\yazi\config\plugins\compress.yazi
+
+# Or with yazi plugin manager
+ya pack -a KKV9/compress
+```
+
+- Add this to your `keymap.toml`:
+
+```toml
+[[manager.prepend_keymap]]
+on   = [ "c", "a" ]
+run  = "plugin compress"
+desc = "Archive selected files"
+```
+
+## Usage
+
+ - Select files or folders to add, then press `c` `a` to create a new archive.
+ - Type a name for the new file. 
+ - The file extention must match one of the supported filetype extentions.
+ - The desired archive/compression command must be installed on your system.