Merge branch 'main' of https://github.com/SteezCram/PboViewer into main

SteezCram · Nov 18, 2020 · a969e0d · a969e0d
2 parents bda3613 + 193086a
commit a969e0d
Showing 1 changed file with 16 additions and 0 deletions.
diff --git 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"`