diff --git a/README.md b/README.md new file mode 100644 index 0000000..00de9ff --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# LilSyncy +A simple and relative fast sync tool for windows. + +Copies folders and files from one folder to another, updating files that have changed and removing files that have been deleted. + +# Downloads +Stable releases can be downloaded [here](https://github.com/Killeroo/LilSyncy/releases/). + +# Usage +``` +LilSyncy --source C:\Path\To\Sync\From\ --destination C:\Path\To\Sync\To\ +``` + +# Arguments +``` +[required] --source Path you want to sync from. +[required] --destination Path you want to sync to. + + --dryrun Run sync without actually moving or deleting any files. + --help Displays this help message. +``` + +## License + +License under the MIT License: + +Copyright (c) 2023 Matthew Carney