From a4fdcf9540d588bd017cc220a01bee760b4e1a9f Mon Sep 17 00:00:00 2001 From: vrtmrz Date: Wed, 27 Oct 2021 18:30:11 +0900 Subject: [PATCH] change information order. --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5e21c60..2204cc5 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,24 @@ _Note: Without synchronization, your files won't be deleted._ If it doesn't be shown. replicate once. 1. It's all done. But if you are sure to resolve all devices and the warning is noisy, click "I'm ready, unlock the database". it unlocks the database completely. +# Designed architecture + +## How does this plugin synchronize. + +![Synchronization](images/1.png) + +1. When notes are created or modified, Obsidian raises some events. obsidian-live-sync catch these events and reflect changes into Local PouchDB. +2. PouchDB automatically or manually replicates changes to remote CouchDB. +3. Another device is watching remote CouchDB's changes, so retrieve new changes. +4. obsidian-live-sync reflects replicated changeset into Obsidian's vault. + +Note: The figure is drawn as single-directional, between two devices. But everything occurs bi-directionally between many devices at once in real. + +## Techniques to keep bandwidth low. + +![dedupe](images/2.png) + + ## Cloudant Setup ### Creating an Instance @@ -136,23 +154,6 @@ example values. | CouchDB Username | (\*3) | apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5 | | CouchDB Password | (\*4) | c2c11651d75497fa3d3c486e4c8bdf27 | -# Designed architecture - -## How does this plugin synchronize. - -![Synchronization](images/1.png) - -1. When notes are created or modified, Obsidian raises some events. obsidian-live-sync catch these events and reflect changes into Local PouchDB. -2. PouchDB automatically or manually replicates changes to remote CouchDB. -3. Another device is watching remote CouchDB's changes, so retrieve new changes. -4. obsidian-live-sync reflects replicated changeset into Obsidian's vault. - -Note: The figure is drawn as single-directional, between two devices. But everything occurs bi-directionally between many devices at once in real. - -## Techniques to keep bandwidth low. - -![dedupe](images/2.png) - # License The source code is licensed MIT.