From bfb951cdcb93018960a3465feb600698a2c0445e Mon Sep 17 00:00:00 2001 From: Ben Papillon Date: Fri, 3 Jan 2025 15:32:09 -0500 Subject: [PATCH] Update README offline mode --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f583b8d..66d9951 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ Schematic schematic = Schematic.builder() ### Offline Mode -In development or testing environments, you may want to avoid making network requests to the Schematic API. You can run Schematic in offline mode; in this case, it does not matter what API key you specify: +In development or testing environments, you may want to avoid making network requests when checking flags or submitting events. You can run Schematic in offline mode: ```java import com.schematic.api.Schematic; @@ -212,6 +212,8 @@ Schematic schematic = Schematic.builder() .build(); ``` +While in offline mode, flag checks will return the default value for the flag being checked, and events will no-op. Other API calls will still be attempted as normal; offline mode does not affect these. + Offline mode works well with flag defaults: ```java