From ee1c38ae177d59667ad28c97673a3d80a49e0857 Mon Sep 17 00:00:00 2001 From: Fahim Masud Choudhury Date: Mon, 8 Jan 2024 17:45:59 +0600 Subject: [PATCH] docs: Update README Add a reference link to the word persistent, as it has a special meaning in the Android system. Fix a few typos. Fixes #183. --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 215c0051..bd9d9ea6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # eDrive -eDrive is a persitent application provided by default with /e/OS. +eDrive is a [persistent][doc-persistence] application provided by default with /e/OS. It synchronizes user's data files to /e/Cloud or a self-hosted cloud. ## Install @@ -22,8 +22,8 @@ and finally `adb reboot`. | /storage/emulated/0/Ringtones | /Ringtones | Ringtones | | /storage/emulated/0/Documents | /Documents | Documents | | /storage/emulated/0/Podcasts | /Podcasts | Podcasts | -| /data/system/users/0/ | /Devices/\/rom_settings/ | Rom settings | -| /data/data/foundation.e.drive/files/ | /Devices/\/rom_settings/app_list/ | Rom settings | +| /data/system/users/0/ | /Devices/\/rom_settings/ | ROM settings | +| /data/data/foundation.e.drive/files/ | /Devices/\/rom_settings/app_list/ | ROM settings | All remote directories are created by eDrive if needed. @@ -31,7 +31,7 @@ All remote directories are created by eDrive if needed. ### How it works -When you register an /e/account the synchronization is enabled by default. +When you register an /e/account, the synchronization is enabled by default. The synchronization is done on `ACTION_SCREEN_OFF` intent if the last sync is greater than 15 min. Otherwise a sync is scheduled each 30 min. @@ -39,14 +39,14 @@ sync is greater than 15 min. Otherwise a sync is scheduled each 30 min. To enable/disable the synchronisation, go into your account settings: -* Application settings (Rom settings) +* Application settings (ROM settings) * Pictures and videos (Images, Movies, Music, Ringtones, Documents and Podcasts) -# Interrobility +# Interoperability -eDrive can also receive some broadcast intent for different purprose: +eDrive can also receive some broadcast intent for different purpose: -**Force the synchronization.** +**Force the synchronization** ```bash adb shell am broadcast -a foundation.e.drive.action.FORCE_SYNC --receiver-include-background @@ -68,4 +68,6 @@ adb shell am broadcast -a foundation.e.drive.action.DUMP_DATABASE --receiver-inc ```bash adb shell am broadcast -a foundation.e.drive.action.FULL_LOG_ON_PROD --receiver-include-background --ez full_log_enable false -``` \ No newline at end of file +``` + +[doc-persistence]: https://developer.android.com/guide/topics/manifest/application-element#persistent \ No newline at end of file -- GitLab