From 37617899489b3f141752ca0666ce2e8a600db1ae Mon Sep 17 00:00:00 2001
From: Sam Scholten
Date: Fri, 24 Oct 2025 15:27:43 +1000
Subject: v0.1.0 - Initial release

add logo
---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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
-- 
cgit v1.2.3