From 0f08ad435f703412a4aa9aca14def23942cd4b5d Mon Sep 17 00:00:00 2001 From: vorotamoroz Date: Fri, 5 Jun 2026 01:08:54 +0900 Subject: [PATCH] (chore): improve English --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ed2540e..e8396a4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Self-hosted LiveSync is a community-developed synchronisation plug-in available on all Obsidian-compatible platforms. It leverages robust server solutions such as CouchDB or object storage systems (e.g., MinIO, S3, R2, etc.) to ensure reliable data synchronisation. -Additionally, it supports peer-to-peer synchronisation using WebRTC, enabling you to synchronise your notes directly between devices without relying on a server. Documentations is available for [Peer-to-Peer Synchronisation](./docs/p2p_sync_updates_2026.md). +Additionally, it supports peer-to-peer synchronisation using WebRTC, enabling you to synchronise your notes directly between devices without relying on a server. Documentation is available for [Peer-to-Peer Synchronisation](./docs/p2p_sync_updates_2026.md). ![obsidian_live_sync_demo](https://user-images.githubusercontent.com/45774780/137355323-f57a8b09-abf2-4501-836c-8cb7d2ff24a3.gif) @@ -25,17 +25,17 @@ Additionally, it supports peer-to-peer synchronisation using WebRTC, enabling yo - Instead of keeping your device online as a stable peer, you can use two pseudo-peers: - [livesync-serverpeer](https://github.com/vrtmrz/livesync-serverpeer): A pseudo-client running on the server for receiving and sending data between devices. - [webpeer](https://github.com/vrtmrz/obsidian-livesync/tree/main/src/apps/webpeer): A pseudo-client for receiving and sending data between devices. - - A pre-built instance is available at [fancy-syncing.vrtmrz.net/webpeer](https://fancy-syncing.vrtmrz.net/webpeer/) (hosted on the vrtmrz blog site). This is also peer-to-peer. Feel free to use it. + - A pre-built instance is available at [fancy-syncing.vrtmrz.net/webpeer](https://fancy-syncing.vrtmrz.net/webpeer/) (hosted on the vrtmrz's blog site). This is also peer-to-peer. Feel free to use it. - For more information, refer to the [English explanatory article](https://fancy-syncing.vrtmrz.net/blog/0034-p2p-sync-en.html) or the [Japanese explanatory article](https://fancy-syncing.vrtmrz.net/blog/0034-p2p-sync). This plug-in may be particularly useful for researchers, engineers, and developers who need to keep their notes fully self-hosted for security reasons. It is also suitable for anyone seeking the peace of mind that comes with knowing their notes remain entirely private. >[!IMPORTANT] > - Before installing or upgrading this plug-in, please back up your vault. -> - Do not enable this plug-in alongside another synchronisation solution at the same time (including iCloud and Obsidian Sync). +> - Do not enable this plug-in alongside another synchronisation solution (including iCloud and Obsidian Sync). > - For backups, we also provide a plug-in called [Differential ZIP Backup](https://github.com/vrtmrz/diffzip). -## How to use +## How to Use ### 3-minute setup - CouchDB on fly.io @@ -43,54 +43,54 @@ This plug-in may be particularly useful for researchers, engineers, and develope [![LiveSync Setup onto Fly.io SpeedRun 2024 using Google Colab](https://img.youtube.com/vi/7sa_I1832Xc/0.jpg)](https://www.youtube.com/watch?v=7sa_I1832Xc) -1. [Setup CouchDB on fly.io](docs/setup_flyio.md) +1. [Set up CouchDB on fly.io](docs/setup_flyio.md) 2. Configure plug-in in [Quick Setup](docs/quick_setup.md) -### Manually Setup +### Manual Setup -1. Setup the server - 1. [Setup CouchDB on fly.io](docs/setup_flyio.md) - 2. [Setup your CouchDB](docs/setup_own_server.md) +1. Set up the server + 1. [Set up CouchDB on fly.io](docs/setup_flyio.md) + 2. [Set up your CouchDB](docs/setup_own_server.md) 2. Configure plug-in in [Quick Setup](docs/quick_setup.md) > [!TIP] -> Fly.io is no longer free. Fortunately, despite some issues, we can still use IBM Cloudant. Refer to [Setup IBM Cloudant](docs/setup_cloudant.md). -> And also, we can use peer-to-peer synchronisation without a server. Or very cheap Object Storage -- Cloudflare R2 can be used for free. -> HOWEVER, most importantly, we can use the server that we trust. Therefore, please set up your own server. -> CouchDB can be run on a Raspberry Pi. (But please be careful about the security of your server). +> Fly.io is no longer free. Fortunately, we can still use IBM Cloudant despite some limitations. Refer to [Set up IBM Cloudant](docs/setup_cloudant.md). +> We can also use peer-to-peer synchronisation without a server. Alternatively, cheap object storage like Cloudflare R2 can be used for free. +> However, most importantly, we can use a server that we trust. Therefore, please set up your own server. +> CouchDB can also be run on a Raspberry Pi (please be mindful of your server's security). -## Information in StatusBar +## Information in the Status Bar -Synchronization status is shown in the status bar with the following icons. +Synchronisation status is shown in the status bar with the following icons. - Activity Indicator - 📲 Network request - Status - ⏚ī¸ Stopped - 💤 LiveSync enabled. Waiting for changes - - ⚡ī¸ Synchronization in progress + - ⚡ī¸ Synchronisation in progress - ⚠ An error occurred -- Statistical indicator +- Statistical Indicators - ↑ Uploaded chunks and metadata - ↓ Downloaded chunks and metadata -- Progress indicator +- Progress Indicators - đŸ“Ĩ Unprocessed transferred items - 📄 Working database operation - 💾 Working write storage processes - âŗ Working read storage processes - đŸ›Ģ Pending read storage processes - đŸ“Ŧ Batched read storage processes - - ⚙ī¸ Working or pending storage processes of hidden files + - ⚙ī¸ Working or pending storage processes for hidden files - 🧩 Waiting chunks - - 🔌 Working Customisation items (Configuration, snippets, and plug-ins) + - 🔌 Working customisation items (configuration, snippets, and plug-ins) -To prevent file and database corruption, please wait to stop Obsidian until all progress indicators have disappeared as possible (The plugin will also try to resume, though). Especially in case of if you have deleted or renamed files. +To prevent file and database corruption, please avoid closing Obsidian until all progress indicators have disappeared as much as possible (although the plug-in will attempt to resume if interrupted). This is especially important if you have deleted or renamed files. ## Tips and Troubleshooting -If you are having problems getting the plugin working see: [Tips and Troubleshooting](docs/troubleshooting.md). +If you are having problems getting the plug-in working, see [Tips and Troubleshooting](docs/troubleshooting.md). ## Acknowledgements -The project has been in continual progress and harmony thanks to: +The project has been in continual progress and harmony thanks to the following: - Many [Contributors](https://github.com/vrtmrz/obsidian-livesync/graphs/contributors). - Many [GitHub Sponsors](https://github.com/sponsors/vrtmrz#sponsors). - JetBrains Community Programs / Support for Open-Source Projects. JetBrains logo @@ -98,7 +98,7 @@ The project has been in continual progress and harmony thanks to: May those who have contributed be honoured and remembered for their kindness and generosity. ## Development Guide -Please refer to [Development Guide](devs.md) for development setup, testing infrastructure, code conventions, and more. +Please refer to the [Development Guide](devs.md) for development setup, testing infrastructure, code conventions, and more. ## License