docs: new desgin

README.md

@@ -1,14 +1,45 @@
 tunasync
 ========
 
+## Design
+
+```
+# Architecture
+
+- Manager: Centural instance on status and job management
+- Worker: Runs mirror jobs
+
+
++----------+  +---+   worker configs   +---+    +----------+     +----------+
+|  Status  |  |   |+-----------------> | w +--->|  mirror  +---->|  mirror  |
+|  Manager |  |   |                    | o |    |  config  |     | provider |
++----------+  | W |  start/stop job    | r |    +----------+     +----+-----+
+              | E |+-----------------> | k |                          |
++----------+  | B |                    | e |       +------------+     |
+|   Job    |  |   |   update status    | r |<------+ mirror job |<----+
+|Controller|  |   | <-----------------+|   |       +------------+
++----------+  +---+                    +---+
+
+
+# Job Run Process
+
++-----------+     +-----------+    +-------------+     +--------------+
+|  pre-job  +--+->|  job run  +--->|   post-job  +-+-->| post-success |
++-----------+  ^  +-----------+    +-------------+ |   +--------------+
+			   |                                   |
+			   |      +-----------------+          |
+			   +------+    post-fail    |<---------+
+					  +-----------------+
+```
+
 ## TODO
 
-- [ ] use context manager to handle job contexts
+- [ ] split to `tunasync-manager` and `tunasync-worker` instances
-- [x] Hooks need "before_exec", "after_exec"
+	- use HTTP as communication protocol
-- [x] implement `tunasynctl tail` and `tunasynctl log` or equivalent feature
+- Web frontend for `tunasync-manager`
-- [x] status file
+	- [ ] start/stop/restart job
-    - [ ] mirror size
+	- [ ] enable/disable mirror
-    - [x] upstream
+	- [ ] view log
-- [x] btrfs backend (create snapshot before syncing)
+- [ ] config file structure
-- [x] add mirror job online
+	- [ ] support multi-file configuration (`/etc/tunasync.d/mirror-enabled/*.conf`)
-- [x] use toml as configuration
+