From 588070748ac83d65132f42a90013b55353dc99ad Mon Sep 17 00:00:00 2001 From: John Donaldson Date: Mon, 28 Oct 2019 17:48:36 +0000 Subject: [PATCH] Adding documentation to the README file --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9d9d9c9..99549f0 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,18 @@ We sometimes to set `teamids.txt` to a bunch of random 8-digit hex values: Remember that team IDs are essentially passwords. +Enabling offline/PWA mode +------------------- + +If the file `state/export_manifest` is found, the server will expose the +endpoint `/current_manifest.json?id=`. This endpoint will return +a list of all files, including static theme content and JSON and content +for currently-unlocked puzzles. This is used by the native PWA +implementation and `Cache` button on the index page to cache all of the +content necessary to display currently-open puzzles while offline. +Grading will be unavailable while offline. Some puzzles may not function +as expected while offline. A valid team ID must be provided. + Mothball Directory ==================