Skip to content

Commit

Permalink
Use “service worker” consistently
Browse files Browse the repository at this point in the history 
This patch also ensures that sentence case is used consistently for titles.

Fixes #705.
  • Loading branch information
@mathiasbynens @annevk
mathiasbynens authored and annevk committed Apr 7, 2016
1 parent d2fdb14 commit 546166a
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 122 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
## What's Going On Here?
## What’s going on here?

Service Workers are a new browser feature that provide event-driven scripts that run independently of web pages. Unlike other workers Service Workers can be shut down at the end of events, note the lack of retained references from documents, and they have access to domain-wide events such as network fetches.
Service workers are a new browser feature that provide event-driven scripts that run independently of web pages. Unlike other workers, service workers can be shut down at the end of events, note the lack of retained references from documents, and they have access to domain-wide events such as network fetches.

ServiceWorkers also have scriptable caches. Along with the ability to respond to network requests from certain web pages via script, this provides a way for applications to "go offline".
Service workers also have scriptable caches. Along with the ability to respond to network requests from certain web pages via script, this provides a way for applications to “go offline”.

Service Workers are meant to replace the ([oft maligned](http://alistapart.com/article/application-cache-is-a-douchebag)) [HTML5 Application Cache](//www.whatwg.org/specs/web-apps/current-work/multipage/offline.html). Unlike AppCache, Service Workers are comprised of scriptable primitives that make it possible for application developers to build URL-friendly, always-available applications in a sane and layered way.
Service workers are meant to replace the ([oft maligned](http://alistapart.com/article/application-cache-is-a-douchebag)) [HTML5 Application Cache](https://html.spec.whatwg.org/multipage/browsers.html#offline). Unlike AppCache, service workers are comprised of scriptable primitives that make it possible for application developers to build URL-friendly, always-available applications in a sane and layered way.

To understand the design and how you might build apps with ServiceWorkers, see the [explainer document](explainer.md).
To understand the design and how you might build apps with service workers, see the [explainer document](explainer.md).

## Spec and API Development
## Spec and API development

For the nitty-gritty of the API, the [draft W3C specification](//slightlyoff.github.io/ServiceWorker/spec/service_worker/index.html) is authoritative. For implementers and developers who seek a more stable version, [Service Workers 1](//slightlyoff.github.io/ServiceWorker/spec/service_worker_1/index.html) is a right document with which the contributors only focus on fixing bugs and resolving compatibility issues.
For the nitty-gritty of the API, the [draft W3C specification](https://slightlyoff.github.io/ServiceWorker/spec/service_worker/) is authoritative. For implementers and developers who seek a more stable version, [Service Workers 1](https://slightlyoff.github.io/ServiceWorker/spec/service_worker_1/) is a right document with which the contributors only focus on fixing bugs and resolving compatibility issues.

Spec development happens via [issues in this repository](https://github.com/slightlyoff/ServiceWorker/issues). For general discussion, please use the [public-webapps@w3.org mailing list](http://lists.w3.org/Archives/Public/public-webapps/) with a `Subject:` prefix of `[service-workers]`.

Updates to the spec must reference [resolved issued marked `needs spec`](issues?labels=needs+spec&state=closed).

To edit the spec locally, you'll need a copy of [the Web Components-based framework which it is built with](//github.com/slightlyoff/web-spec-framework). To fetch it, clone the repo and run:
To edit the spec locally, you’ll need a copy of [the Web Components-based framework which it is built with](https://github.com/slightlyoff/web-spec-framework). To fetch it, clone the repo and run:

```sh
git submodule update --init --recursive
Expand All @@ -26,7 +26,7 @@ To make edits to the design, please send pull requests against the spec (`spec/s

## Examples

The w3c web mobile group have defined a [series of use-cases where ServiceWorker is particularly useful](https://github.com/w3c-webmob/ServiceWorkersDemos). You can help by adding more use cases, draft implementation code, or even working examples once browsers support the required APIs.
The W3C Web Mobile Group have defined a [series of use-cases where ServiceWorker is particularly useful](https://github.com/w3c-webmob/ServiceWorkersDemos). You can help by adding more use cases, draft implementation code, or even working examples once browsers support the required APIs.


## About labels and milestones on issues
Expand All @@ -38,12 +38,12 @@ This is to explain how we use labels and milestones to triage the issues. Note:

**milestone**: is used to mark issues we agreed to get done in principle by a given revision. For the sake of efficiency, we tend to only focus on the current milestone and leave everything else without specific milestones.

**impacts MVP**: is used to mark issues impacting the "Minimal Viable Product". The MVP is the minimal scope of API that can solve actual use cases. These issues have the highest priority.
**impacts MVP**: is used to mark issues impacting the “Minimal Viable Product”. The MVP is the minimal scope of API that can solve actual use cases. These issues have the highest priority.

*Risk labels for impacts MVP issues*
**medium risk**: to further refine the "impacts MVP" issues. It indicates that the issue is moderately complex and that reaching a conclusion might take some time. These are of higher priority than issues with no risk label but are of lower priority than issues with a "high risk" label.
*Risk labels for impacts MVP issues*
**medium risk**: to further refine the “impacts MVP” issues. It indicates that the issue is moderately complex and that reaching a conclusion might take some time. These are of higher priority than issues with no risk label but are of lower priority than issues with a “high risk” label.

**high risk**: to further refine the "impacts MVP" issues. It indicates that the issue is significantly complex and that reaching a conclusion might take a lot of time and effort. These are of higher priority than issues with no risk label or a "medium risk" label.
**high risk**: to further refine the “impacts MVP” issues. It indicates that the issue is significantly complex and that reaching a conclusion might take a lot of time and effort. These are of higher priority than issues with no risk label or a “medium risk” label.



Expand All @@ -54,7 +54,7 @@ This is to explain how we use labels and milestones to triage the issues. Note:

**decided**: to record that a decision has been made.

**invalid**: when something doesn't constitute a valid issue.
**invalid**: when something doesn’t constitute a valid issue.

**wontfix**: a decision has been made not to pursue this issue further.

Expand All @@ -67,8 +67,8 @@ This is to explain how we use labels and milestones to triage the issues. Note:

**fetch**: relates to Fetch

**lifecycle**: relates to lifecycle aspects of Service Worker
**lifecycle**: relates to lifecycle aspects of service worker

**cache**: relevant to the Cache APIs

**question**: not an actual issue. Items that have been filed in order to gain a better understanding of Service Worker.
**question**: not an actual issue. Items that have been filed in order to gain a better understanding of service worker.

0 comments on commit 546166a

Please sign in to comment.