diff options
| author | Sam Scholten | 2025-10-24 15:27:43 +1000 |
|---|---|---|
| committer | Sam Scholten | 2025-10-24 15:27:50 +1000 |
| commit | 37617899489b3f141752ca0666ce2e8a600db1ae (patch) | |
| tree | 669c5d17d2bcaec642f2786476924433c980cbfb /README.md | |
| download | usync-37617899489b3f141752ca0666ce2e8a600db1ae.tar.gz usync-37617899489b3f141752ca0666ce2e8a600db1ae.zip | |
v0.1.0 - Initial release
add logo
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..40d53af --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# usync + +<img src="logo.png" width="120" markdown="1"> + +Sync any two paths with cloud backup. + +## Setup + +```bash +git clone <repo> && cd usync +just install-deps +# Edit justfile: set SOURCE and TARGET paths +rclone config +just setup +``` + +## Use + +```bash +just sync-paths # Between paths +just sync-cloud # To cloud +just status # Check +``` + +## Structure + +``` +SOURCE/usync/ # Your files +TARGET/usync/ # Copy +cloud:/usync/ # Backup +``` + +## Commands + +- `setup` - Create directories +- `check` - Verify paths +- `sync-paths` - Fast sync (unison) +- `sync-cloud` - Cloud backup (rclone) +- `status` - Show state + +## Files + +- `justfile` - Set SOURCE and TARGET paths +- `unison-profile.prf` - Sync settings |
