From dc673a34bcbd811d5d2be2ea6e01cfd9dbb93437 Mon Sep 17 00:00:00 2001
From: Peter Beverloo <peter@lvp-media.com>
Date: Wed, 27 Mar 2019 00:27:52 +0000
Subject: [PATCH] Create README.md

---
 README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8c0efa0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,79 @@
+# Periodic Background Sync
+
+**Written**: 2019-03-26<br/>
+**Updated**: 2019-03-27
+
+Periodic Background Sync is a method that enables web applications to periodically synchronize data
+in the background, building on the [Background Sync](https://wicg.github.io/BackgroundSync/spec/)
+specification that defines a method for one-off synchronization.
+
+The [original explainer](https://github.com/WICG/BackgroundSync/blob/master/explainer.md#periodic-synchronization-in-design)
+included a thorough exploration of this capability, but it neither got specified, nor ever shipped
+in a browsing engine. This was caused by a combination of low interest from both developers and
+other browser engines, and high complexity due to an unclear permission model. We believe the
+situation has changed since.
+
+If this proposal stands, we plan to extend the [Background Sync](https://wicg.github.io/BackgroundSync/spec/)
+specification to describe this ability as well, and move the document to the standardization track.
+
+## Use cases
+  * todo
+
+## Why do we care?
+  * todo
+
+## Goals
+  * todo
+
+## Non-goals
+  * todo
+
+# Example code
+
+## Requesting a periodic sync
+```javascript
+// index.html
+
+navigator.serviceWorker.ready.then(registration => {
+  registration.periodicSync.register('get-latest-news', {
+    // Minimum interval at which the sync may fire.
+    minInterval: 24 * 60 * 60 * 1000,
+  });
+});
+````
+
+## Responding to a periodic sync event
+```javascript
+// service_worker.js
+
+self.addEventListener('periodicsync', event => {
+  if (event.tag == 'get-latest-news') {
+    event.waitUntil(fetchAndCacheLatestNews());
+  }
+});
+```
+
+# Security and Privacy
+
+TODO
+
+# Design decisions
+
+## Separate interface or extending one-shot Background Sync?
+We think that the use cases for periodic background sync are sufficiently different from the use
+cases for one-shot background sync to justify having a separate event in the developer's service
+worker: synchronizing data in response to a user action versus opportunistically refreshing
+content. In addition, there are different timing guarantees: one-shot sync has to run as soon as
+possible, where the browser has the final timing decision for periodic sync.
+
+The interfaces mimic regular Background Sync, but substitute `navigator.sync` with
+`navigator.periodicSync` for symmetry with the event that will be fired in the service worker.
+
+# References and acknowledgements
+
+  * [Background Sync](https://wicg.github.io/BackgroundSync/spec/)
+  * [Push API](https://w3c.github.io/push-api/)
+
+Many thanks to the authors of the original explainer for starting the project, and to @mugdhalakhani
+for picking periodic sync up again. Thanks to @jakearchibald and @rayankans for their ideas, input
+and discussion.