From 9d3675f28257555d1f61bcb6e8b4cfc679b72a3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mladen=20Jablanovi=C4=87?= Date: Tue, 11 Jun 2024 09:30:13 +0200 Subject: [PATCH] Explain options in README (#35) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 492a828..15f38f3 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,16 @@ i18n }); ``` +### Options + +The backend accepts several options: + +* `distribution` (required): The ID of your Phrase Strings OTA distribution +* `secret` (required): The secret token of your Phrase Strings OTA distribution. There are different secrets for `development` (i.e. beta) and `production` environments +* `appVersion`: You can prevent some OTA releases from being serverd to certain app versions by providing minimum and maximum app version in Phrase Strings +* `cacheExpirationTime`: See [Caching](#caching) below +* `host`: By default, this library uses EU instance of Phrase Strings, if you use US DC, set this to `https://ota.us.phrase.com` + ## Caching The library is caching translations and won't check for new translations for 5 minutes. This can be configured by setting the `cacheExpirationTime` option in the backend configuration for testing purposes. It's recommended to use at least 5 minutes in production.