diff --git a/README.md b/README.md index b8e601b..3720165 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # PboViewer Cross-platform PBO maker / unpacker + +## GUI +The GUI is availble to all the platform. + +Here is a screenshot of the window: + +![alt text](https://i.ibb.co/ZH0rBCK/Pbo-Viewer-GUI-dzf-ZWJWQld.png) + +## CLI +You have two command for the CLI: +- packFolder, arguments: --path or -p, path of the folder to pack +- unpackFolder, arguments: --path or -p, path of the PBO to unpack + +Here is one exemple for each command: +- `./PboViewer packFolder --path="C:\test"` +- `./PboViewer unpackFolder --path="C:\test"`