improved grammar & fixed typos in docs and plugin texts

2025-12-13 09:45:56 +00:00 · 2022-08-04 14:34:45 +08:00
parent f0ffb0620e
commit 63abeb7f6b
6 changed files with 86 additions and 87 deletions
--- a/README.md
+++ b/README.md
@@ -3,32 +3,32 @@
 [Japanese docs](./README_ja.md).

 Self-hosted LiveSync is a community implemented synchronization plugin.  
-It uses Self-hosted or you procured CouchDB as the server. Available on every obsidian installed devices.  
+A purchased or self-hosted CouchDB acts as the intermediate server. Available on every obsidian-compatible platform.

-Note: It has no compatibilities with official "Sync".
+Note: It has no compatibility with the official "Obsidian Sync".

 ![obsidian_live_sync_demo](https://user-images.githubusercontent.com/45774780/137355323-f57a8b09-abf2-4501-836c-8cb7d2ff24a3.gif)

-If you install or upgrade LiveSync, please back your vault up.
+Before installing or upgrading LiveSync, please back your vault up.

 ## Features

 -   Visual conflict resolver included.
-   Synchronize with other devices bidirectionally near-real-time
+-   Bidirectional synchronization between devices nearly in real-time
 -   You can use CouchDB or its compatibles like IBM Cloudant.
-   End-to-End encryption.
+-   End-to-End encryption supported.
 -   Plugin synchronization(Beta)
 -   Receive WebClip from [obsidian-livesync-webclip](https://chrome.google.com/webstore/detail/obsidian-livesync-webclip/jfpaflmpckblieefkegjncjoceapakdf) (End-to-End encryption will not be applicable.)

-It must be useful for the Researcher, Engineer, Developer who has to keep NDA or something like agreement. Especially, in some companies, people have to store all data to their fully controlled host, even End-to-End encryption applied.
+Useful for researchers, engineers and developers with a need to keep their notes fully self-hosted for security reasons. Or just anyone who would like the peace of mind knowing that their notes are fully private. 

 ## IMPORTANT NOTICE

-   Do not use with other synchronize solutions. Before enabling this plugin, make sure to disable other synchronize solutions, to avoid content corruption or duplication. If you want to synchronize to both backend, sync one by one, please.
-    This includes making your vault on the cloud-controlled folder(e.g., Inside the iCloud folder).
-   This is the synchronization plugin. Not backup solutions. Do not rely on this for backup.
-   When the device's storage has been run out, Database corruption may happen.
-   When editing hidden files or any other invisible files from obsidian, the file wouldn't be kept in the database. (**Or be deleted.**)
+-   Do not use in conjunction with another synchronization solution (including iCloud, Obsidian Sync). Before enabling this plugin, make sure to disable all the other synchronization methods to avoid content corruption or duplication. If you want to synchronize to two or more services, do them one by one and never enable two synchronization methods at the same time.
+    This includes not putting your vault inside a cloud-synchronized folder (eg. an iCloud folder or Dropbox folder)
+-   This is a synchronization plugin. Not a backup solutions. Do not rely on this for backup.
+-   If the device's storage runs out, database corruption may happen.
+-   Hidden files or any other invisible files wouldn't be kept in the database, thus won't be synchronized. (**and may also get deleted**)

 ## How to use

@@ -38,58 +38,57 @@ First, get your database ready. IBM Cloudant is preferred for testing. Or you ca
 1. [Setup IBM Cloudant](docs/setup_cloudant.md)
 2. [Setup your CouchDB](docs/setup_own_server.md)

-Note: Information about hosting service wanted! Currently, [Using fly.io](https://github.com/vrtmrz/obsidian-livesync/discussions/85) is on the table.
+Note: More information about alternative hosting methods needed! Currently, [using fly.io](https://github.com/vrtmrz/obsidian-livesync/discussions/85) is being discussed.

 ### First device

 1. Install the plugin on your device.
-2. Configure with the remote database.
+2. Configure remote database infomation.
 	1. Fill your server's information into the `Remote Database configuration` pane.
-	2. Enabling `End to End Encryption` is recommended. After inputting the passphrase, you have to press `Just apply`.
-	3. Hit `Test Database Connection` and make sure that the plugin says `Connected`.
-	4. Hit `Check database configuration` and make sure all tests have been passed.
-3. Configure how to synchronize on `Sync setting`. (You can leave these  configures later)
+	2. Enabling `End to End Encryption` is recommended. After entering a passphrase, click `Apply`.
+	3. Click `Test Database Connection` and make sure that the plugin says `Connected to (your-database-name)`.
+	4. Click `Check database configuration` and make sure all tests have passed.
+3. Configure when should the synchronization happen in `Sync Settings` tab. (You can also leave them for later)
 	1. If you want to synchronize in real-time, enable `LiveSync`.
-	2. Or, set up the synchronization as you like.
-	3. Additional configuration is also here. I recommend enabling `Use Trash for deleted files, but you can leave all configurations disabled.
+	2. Or, set up the synchronization as you like. By default, none of the settings are enabled, meaning you would need to manually trigger the synchronization process.
+	3. Additional configurations are also here. I recommend enabling `Use Trash for deleted files`, but you can also leave all configurations as-is.
 4. Configure miscellaneous features.
-	1. Enabling `Show staus inside editor` bring you information. While edit mode, you can see the status on the top-right of the editor. (Recommended)
-5. Back to the editor. I hope that initial scan is in the progress or done.
-6. When status became stabilized (All ⏳ and 🧩 have been disappeared), you are ready to synchronize with the server.
-7. Press the replicate icon on the Ribbon or run `Replicate now` from the Command pallet. You'll send all your data to the server.
-8. Open the command palette, `Copy setup URI`, and set the passphrase to encrypt the information. Then your configuration will be copied to the clipboard. Please share copied URI with your other devices.
-**IMPORTANT NOTICE: BE CAREFUL TO TREAT THIS URI. THE URI CONTAINS YOUR CREDENTIALS EVEN THOUGH NOBODY COULD READ WITHOUT THE PASSPHRASE.**
+	1. Enabling `Show staus inside editor` shows status at the top-right corner of the editor while in editing mode. (Recommended)
+5. Go back to the editor. Wait for the initial scan to complete.
+6. When the status no longer changes and shows a ⏹️ for COMPLETED (No ⏳ and 🧩 icons), you are ready to synchronize with the server.
+7. Press the replicate icon on the Ribbon or run `Replicate now` from the command palette. This will send all your data to the server.
+8. Open command palette, run `Copy setup URI`, and set a passphrase. This will export your configuration to clipboard as a link for you to import into your other devices.
+
+**IMPORTANT: BE CAREFUL NOT TO SHARE THIS LINK. THE URI CONTAINS ALL YOUR CREDENTIALS.** (even though nobody could read them without the passphrase)

 ### Subsequent Devices

+<!-- what does this line mean? what is a timestamp? could this be too much unnecessary technical details? -->
 Strongly recommend using the vault in which all files are completely synchronized including timestamps. Otherwise, some files will be corrupted if failed to resolve conflicts. To simplify, I recommend using a new empty vault.

 1. Install the plug-in.
-2. Open the link that you had been copied to the other device.
-3. The plug-in asks you that are you sure to apply the configurations. Please answer `Yes` and the following instruction below:
+2. Open the link that you have exported from the first device.
+3. The plug-in will ask you whether you are sure to apply the configurations. Answer `Yes`, then follow these instructions:
 	1. Answer `Yes` to `Keep local DB?`.
-		*Note: If you started with existed vault, you have to answer `No`. And `No` to `Rebuild the database?`.*
+		*Note: If you start with an existing vault, you have to answer `No` to this question and also answer `No` to `Rebuild the database?`.*
 	2. Answer `Yes` to `Keep remote DB?`.
 	3. Answer `Yes` to `Replicate once?`.
-	Yes, you have to answer `Yes` to everything.
-	Then, all your settings are copied from the first device.
-4. Your notes will arrive soon.
+	Then, all your settings should be successfully imported from the first device.
+4. Your notes should get synchronized soon.

 ## Something looks corrupted...

-Please open the link again and Answer as below:
- If your local database looks corrupted
-(in other words, when your Obsidian getting weird even standalone.)
+Please open the configuration link again and Answer as below:
+- If your local database looks corrupted (in other words, when your Obsidian getting weird even standalone.)
 	- Answer `No` to `Keep local DB?`
- If your remote database looks corrupted
-(in other words, when something happens while replicating)
+- If your remote database looks corrupted (in other words, when something happens while replicating)
 	- Answer `No` to `Keep remote DB?`

-If you answered `No` to both, your databases will be rebuilt by the content on your device. And the remote database will lock out other devices. You have to synchronize all your devices again. (When this time, almost all your files should be synchronized including a timestamp. So you can use the existed vault).
+If you answered `No` to both, your databases will be rebuilt by the content on your device. And the remote database will lock out other devices. You have to synchronize all your devices again. (When this time, almost all your files should be synchronized with a timestamp. So you can use a existed vault).

 ## Test Server

-Setting up an instance of Cloudant or local CouchDB is a little complicated, so I made the [Tasting server of self-hosted-livesync](https://olstaste.vrtmrz.net/) up. Try free!  
+Setting up an instance of Cloudant or local CouchDB is a little complicated, so I set up a [Tasting server for self-hosted-livesync](https://olstaste.vrtmrz.net/). Try it out for free!  
 Note: Please read "Limitations" carefully. Do not send your private vault.

 ## Information in StatusBar
@@ -98,33 +97,33 @@ Synchronization status is shown in statusbar.

 -   Status
    -   ⏹️ Stopped
-    -   💤 LiveSync is enabled. Waiting for changes.
-    -   ⚡️ Synchronize is now in progress.
-    -   ⚠ Error occurred.
-   ↑ Uploaded pieces
+    -   💤 LiveSync enabled. Waiting for changes.
+    -   ⚡️ Synchronization in progress.
+    -   ⚠ An error occurred.
+-   ↑ Uploaded pieces <!-- is a "piece" the same thing as a "chunk"? -->
 -   ↓ Downloaded pieces
-   ⏳ Number of the pending processes
-   🧩 Number of the files that waiting for their chunks.
-If you have deleted or renamed files, please wait until ⏳ disappeared.
+-   ⏳ Number of pending processes
+-   🧩 Number of files waiting for their chunks.
+If you have deleted or renamed files, please wait until ⏳ icon disappeared.


 ## Hints
-   When the folder became empty by replication, The folder will be deleted in the default setting. But you can change this behaivour. Check the [Settings](docs/settings.md).
-   LiveSync mode drains many batteries in mobile devices. Periodic sync and some automatic sync is recommended.
-   Mobile Obsidian can not connect to the non-secure(HTTP) or local CA-signed servers, even though the certificate is stored in the device store.
+-   If a folder becomes empty after a replication, it will be deleted by default. But you can toggle this behaviour. Check the [Settings](docs/settings.md).
+-   LiveSync mode drains more batteries in mobile devices. Periodic sync with some automatic sync is recommended.
+-   Mobile Obsidian can not connect to a non-secure (HTTP) or a locally-signed servers, even if the root certificate is installed on the device.
 -   There are no 'exclude_folders' like configurations.
-   When synchronized, files are compared by their modified times and overwritten by the newer ones once. Then plugin checks the conflicts and if a merge is needed, the dialog will open.
-   Rarely, the file in the database would be broken. The plugin will not write storage when it looks broken, so some old files must be on your device. If you edit the file, it will be cured. But if the file does not exist on any device, can not rescue it. So you can delete these items from the setting dialog.
+-   While synchronizing, files are compared by their modification time and the older ones will be overwritten by the newer ones. Then plugin checks for conflicts and if a merge is needed, a dialog will open.
+-   Rarely, a file in the database could be corrupted. The plugin will not write to local storage when a file looks corrupted. If a local version of the file is on your device, the corruption could be fixed by editing the local file and synchronizing it. But if the file does not exist on any of your devices, then it can not be rescued. In this case you can delete these items from the settings dialog.
 -   If your database looks corrupted, try "Drop History". Usually, It is the easiest way.
-   To stop the bootup sequence for fixing problems on databases, you can put `redflag.md` on top of your vault.
-   Q: Database is growing, how can I shrink it up?
-    A: each of the docs is saved with their old 100 revisions to detect and resolve confliction. Picture yourself that one device has been off the line for a while, and joined again. The device has to check his note and remote saved note. If exists in revision histories of remote notes even though the device's note is a little different from the latest one, it could be merged safely. Even if that is not in revision histories, we only have to check differences after the revision that both devices commonly have. This is like The git's conflict resolving method. So, We have to make the database again like an enlarged git repo if you want to solve the root of the problem.
+-   To stop the bootup sequence (eg. for fixing problems on databases), you can put a `redflag.md` file at the root of your vault.
+-   Q: Database is growing, how can I shrink it down?
+    A: each of the docs is saved with their past 100 revisions for detecting and resolving conflicts. Picturing that one device has been offline for a while, and comes online again. The device has to compare its notes with the remotely saved ones. If there exists a historic revision in which the note used to be identical, it could be updated safely (like git fast-forward). Even if that is not in revision histories, we only have to check the differences after the revision that both devices commonly have. This is like git's conflict resolving method. So, We have to make the database again like an enlarged git repo if you want to solve the root of the problem.
 -   And more technical Information are in the [Technical Information](docs/tech_info.md)
 -   If you want to synchronize files without obsidian, you can use [filesystem-livesync](https://github.com/vrtmrz/filesystem-livesync).
-   WebClipper is also available.
-Available from on Chrome Web Store:[obsidian-livesync-webclip](https://chrome.google.com/webstore/detail/obsidian-livesync-webclip/jfpaflmpckblieefkegjncjoceapakdf)
+-   WebClipper is also available on Chrome Web Store:[obsidian-livesync-webclip](https://chrome.google.com/webstore/detail/obsidian-livesync-webclip/jfpaflmpckblieefkegjncjoceapakdf)
+
 Repo is here: [obsidian-livesync-webclip](https://github.com/vrtmrz/obsidian-livesync-webclip). (Docs are work in progress.)

 ## License

-The source code is licensed MIT.
+The source code is licensed under the MIT License.