From 3d09bbc38895c737c1296dd9fc3356748335a799 Mon Sep 17 00:00:00 2001 From: aaron-jack-manning Date: Fri, 9 Sep 2022 11:19:01 +1000 Subject: [PATCH] note about sequential ids and asynchronous syncing --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b043ac3..7fc78ae 100755 --- a/README.md +++ b/README.md @@ -76,6 +76,12 @@ Then you can run `toru new` to create your first task. --- +## Backup and Syncing + +Toru stores tasks and other metadata locally in the folder of the vault in the interest of making that data easily accessible for backups, syncing across devices, and to be easy to export from. However, because Toru uses sequential IDs, sharing a vault across computers asynchronously, such as with Git, can cause different notes to be in conflict with each other. If all vault metadata is synced across devices completely before use, such conflicts can be avoided. + +--- + ## Planned Changes - Validate invariants at the point of saving, to create consistency across creating and editing notes.