Skip to content

Commit c45c332

Browse files
committed
Update README.md with v1.04 release links and detailed CLI usage
1 parent a34ef0a commit c45c332

1 file changed

Lines changed: 26 additions & 7 deletions

File tree

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Vark - Simple LZAV Archive
22

33
[![build](https://github.com/hypernewbie/vark/actions/workflows/build.yml/badge.svg)](https://github.com/hypernewbie/vark/actions/workflows/build.yml)
4-
[![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)](https://github.com/hypernewbie/vark/releases/download/v1.03/vark-windows-v1.03.zip) [![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)](https://github.com/hypernewbie/vark/releases/download/v1.03/vark-linux-v1.03.zip) [![macOS](https://img.shields.io/badge/macOS-000000?style=for-the-badge&logo=apple&logoColor=white)](https://github.com/hypernewbie/vark/releases/download/v1.03/vark-macos-v1.03.zip)
4+
[![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)](https://github.com/hypernewbie/vark/releases/download/v1.04/vark-windows-v1.04.zip) [![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)](https://github.com/hypernewbie/vark/releases/download/v1.04/vark-linux-v1.04.zip) [![macOS](https://img.shields.io/badge/macOS-000000?style=for-the-badge&logo=apple&logoColor=white)](https://github.com/hypernewbie/vark/releases/download/v1.04/vark-macos-v1.04.zip)
55

66
### Load stuff at DDR2 RAM speed!
77

@@ -84,12 +84,31 @@ VarkCloseArchive( vark );
8484
8585
### CLI
8686
```
87-
Usage:
88-
vark -c <archive> <files...> Create archive
89-
vark -a <archive> <files...> Append to archive
90-
vark -x <archive> Extract archive
91-
vark -l <archive> List archive contents
92-
vark <archive> Smart mode (Extract if .vark, Create/Append otherwise)
87+
Usage: vark [--help] [--version] [-c] [-cs] [-a] [-as] [-x] [-l] [-v] archive [files]...
88+
89+
A minimal LZAV archive tool for fast compression and decompression. Supports sharded compression for efficient random access to large files. Use without flags for smart mode: extracts existing archives or creates new ones automatically.
90+
91+
Positional arguments:
92+
archive archive file path
93+
files input files or directories [nargs: 0 or more]
94+
95+
Optional arguments:
96+
-h, --help shows help message and exits
97+
-v, --version prints version information and exits
98+
-c Create archive
99+
-cs Create archive (sharded compression)
100+
-a Append to archive
101+
-as Append to archive (sharded)
102+
-x Extract archive
103+
-l List archive contents
104+
-v Verify archive integrity
105+
106+
Examples:
107+
vark data.vark Extract archive (smart mode)
108+
vark -c game.vark assets/ Create archive from directory
109+
vark -cs textures.vark images/ Create with sharded compression
110+
vark -a game.vark newfile.dat Append file to existing archive
111+
vark -l game.vark List archive contents
93112
```
94113
## Build
95114

0 commit comments

Comments
 (0)