diff --git a/README.md b/README.md index 1a296cc..e9ef295 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ Library and CLI tool for working with Unreal Engine .pak files. - Unpacking is guarded against malicious pak that attempt to write to parent directories ## cli -``` +```console +$ repak --help Usage: repak [OPTIONS] Commands: @@ -31,6 +32,30 @@ Options: -V, --version Print version ``` +### packing +```console +$ find mod +mod +mod/assets +mod/assets/AssetA.uasset +mod/assets/AssetA.uexp + +$ repak pack -v mod +packing assets/AssetA.uasset +packing assets/AssetA.uexp +Packed 4 files to mod.pak + +$ repak list mod.pak +assets/AssetA.uasset +assets/AssetA.uexp +``` + +### unpacking +```console +$ repak --aes-key 0x12345678 unpack MyEncryptedGame.pak +Unpacked 12345 files to MyEncryptedGame from MyEncryptedGame.pak +``` + ## compatibility | UE Version | Version | Version Feature | Read | Write | diff --git a/repak_cli/tests/docs.rs b/repak_cli/tests/docs.rs index 9494ff3..da803cf 100644 --- a/repak_cli/tests/docs.rs +++ b/repak_cli/tests/docs.rs @@ -20,5 +20,5 @@ fn test_readme_help() { let readme = std::fs::read_to_string(workspace_dir().join("README.md")).unwrap(); - assert!(readme.contains(&format!("```\n{help}```"))); + assert!(readme.contains(&format!("```console\n$ repak --help\n{help}```"))); }