started v2

README.md

@@ -1,8 +1,28 @@
-# pack deployer
 
-- a simple utility to automatically archive and move your resourcepacks into a folder.
+# Pack Sync
+### A simple utility for resoucepack developers who like to stay organised.
 
-## use cases
+### Use Case:
+- You have a folder full of all your projects working on minecraft resource packs
+- You want to be able to automatically archive these files and move them to your resourcepacks folders for testing
+- You make modular packs with different themes that need to be kept organised
 
-this may be useful if you regularly create resourcepacks and want to organise your projects in different folders. 
-the utility recursively scans directories in the project folder and organises packs into a folder
+### How pack sync can help
+The pack sync client is a command line utility that allows you to automatically 
+archive and load all of your resourcepacks into correct folders. 
+
+
+### Usage:
+
+- start by creating a config.toml file
+```toml
+repository = "."
+resourcepacks = "_resourcepacks"
+ignore_folder_prefix = "_"
+
+[versions.1-8-9]
+resourcepacks = "mc_instances/1.8.9/resourcepacks"
+
+[versions.1-20-1]
+resourcepacks = "mc_instances/1.20.4/resourcepacks"
+```