From 4387225ee3d5b06691137071f204ec5b2610d1e3 Mon Sep 17 00:00:00 2001 From: Andrew Gunnerson Date: Sat, 19 Aug 2023 14:49:31 -0400 Subject: [PATCH] README.md: Document update checks Issue: #5 Signed-off-by: Andrew Gunnerson --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 44bc459..07eb377 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,10 @@ Custota is installed via a Magisk/KernelSU module so that it can run as a system 7. That's it! +Once the OTA server URL is configured, Custota will automatically check for updates periodically. The checks can be turned off completely or extended to automatically install the updates as well. + +To reduce battery usage, the scheduling of the update checks is controlled by Android. They run at most once every 6 hours and will not run at all if the `Require unmetered network` or `Require sufficient battery level` conditions aren't met. + ## OTA server Custota only requires a basic webserver capable of serving static files and supporting the HTTP `Range` header. Any standard webserver, like Apache, Nginx, or Caddy, will do the trick. For testing, Caddy is very useful because it can serve files from a directory without setting up any config files: