summaryrefslogtreecommitdiffstats
path: root/services/settings/dumps/readme.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--services/settings/dumps/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/services/settings/dumps/readme.md b/services/settings/dumps/readme.md
new file mode 100644
index 0000000000..8daea50525
--- /dev/null
+++ b/services/settings/dumps/readme.md
@@ -0,0 +1,12 @@
+# Remote Settings Initial Data
+
+In order to reduce the amount of data to be downloaded on first synchronization,
+a JSON dump from the records present on the remote server can be shipped with the
+release.
+
+A bot will update the files automatically. For collections that should not be kept
+in sync, put the JSON dumps in ../static-dumps/ instead.
+
+Dumps from dumps/ and static-dumps/ are packaged into the same resource path,
+thus looking the same to the client code and also implying that filenames must
+be unique between the two directories.