Skip to content

Commit

Permalink
Rename "Bundled Exchanges" to "Web Bundles" everywhere.
Browse files Browse the repository at this point in the history
The bundled things aren't really exchanges anymore: they're a request
URL and a response that is expected to include its content negotiation
information in the Variants header.
  • Loading branch information
jyasskin committed Nov 8, 2019
1 parent 271865a commit 424a50e
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 20 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -67,7 +67,7 @@ Install this with `go install github.com/WICG/webpackage/go/signedexchange/cmd/.

See [go/signedexchange](go/signedexchange) for the usage of the tool.

#### Bundled HTTP Exchanges
#### Web Bundles

Install this with `go install github.com/WICG/webpackage/go/bundle/cmd/...`.

Expand Down
14 changes: 7 additions & 7 deletions draft-yasskin-wpack-bundled-exchanges.md
@@ -1,7 +1,7 @@
---
coding: utf-8

title: Bundled HTTP Exchanges
title: Web Bundles
docname: draft-yasskin-wpack-bundled-exchanges-latest
category: std

Expand Down Expand Up @@ -44,11 +44,11 @@ informative:

--- abstract

Bundled exchanges provide a way to bundle up groups of HTTP request+response
pairs to transmit or store them together. They can include multiple top-level
resources with one identified as the default by a primaryUrl metadata, provide
random access to their component exchanges, and efficiently store 8-bit
resources.
Web bundles provide a way to bundle up groups of HTTP responses, with the URLs
and request URLs that produced them, to transmit or store them together. They
can include multiple top-level resources with one identified as the default by a
primaryUrl metadata, provide random access to their component exchanges, and
efficiently store 8-bit resources.

--- note_Note_to_Readers

Expand Down Expand Up @@ -874,7 +874,7 @@ field, clients SHOULD reject bundles served without it.
## Internet Media Type Registration

IANA is requested to register the MIME media type ({{!IANA.media-types}}) for
bundled exchanges, application/webbundle, as follows:
web bundles, application/webbundle, as follows:

* Type name: application

Expand Down
6 changes: 3 additions & 3 deletions explainer.md
Expand Up @@ -12,7 +12,7 @@ TAG's Web Packaging Draft](https://w3ctag.github.io/packaging-on-the-web/)~~.
- [Component documents](#component-documents)
- [List of use cases](#list-of-use-cases)
- [Signed HTTP exchanges](#signed-http-exchanges)
- [Bundled exchanges](#bundled-exchanges)
- [Web bundles](#web-bundles)
- [Loading specification](#loading-specification)
- [Use cases](#use-cases)
- [Offline installation](#offline-installation)
Expand Down Expand Up @@ -101,7 +101,7 @@ We publish [periodic snapshots of this
draft](https://tools.ietf.org/html/draft-yasskin-httpbis-origin-signed-exchanges-impl)
so that test implementations can interoperate.

### Bundled exchanges
### Web bundles

We're defining a [new Zip-like archive
format](https://wicg.github.io/webpackage/draft-yasskin-wpack-bundled-exchanges.html)
Expand All @@ -126,7 +126,7 @@ the publishing URLs of their contained exchanges.
<a id="loading"></a>
### Loading specification

The [Web Package Loading specification](https://wicg.github.io/webpackage/loading.html) specifies how browsers load signed exchanges, and will eventually also describe how to load bundled exchanges.
The [Web Package Loading specification](https://wicg.github.io/webpackage/loading.html) specifies how browsers load signed exchanges, and will eventually also describe how to load web bundles.

## Use cases

Expand Down
17 changes: 10 additions & 7 deletions go/bundle/README.md
@@ -1,14 +1,16 @@
# go/bundle
This directory contains a reference implementation of [Bundled HTTP Exchanges](https://wicg.github.io/webpackage/draft-yasskin-wpack-bundled-exchanges.html) spec.
This directory contains a reference implementation of the [Web
Bundles](https://wicg.github.io/webpackage/draft-yasskin-wpack-bundled-exchanges.html)
spec.

## Overview
We currently provide three command-line tools: `gen-bundle`, `sign-bundle` and `dump-bundle`.

`gen-bundle` command is a bundle generator tool. `gen-bundle` consumes a set of http exchanges (currently in the form of [HAR format](https://w3c.github.io/web-performance/specs/HAR/Overview.html), URL list file, or static files in a local directory), and emits a bundled exchange file.
`gen-bundle` command is a bundle generator tool. `gen-bundle` consumes a set of http exchanges (currently in the form of [HAR format](https://w3c.github.io/web-performance/specs/HAR/Overview.html), URL list file, or static files in a local directory), and emits a web bundle.

`sign-bundle` command attaches a signature to a bundle. `sign-bundle` takes an existing bundle file, a certificate and a private key, and emits a new bundle file with cryptographic signature for the bundled exchanges added.
`sign-bundle` command attaches a signature to a bundle. `sign-bundle` takes an existing bundle file, a certificate and a private key, and emits a new bundle file with cryptographic signature for the bundled resources added.

`dump-bundle` command is a bundle inspector tool. `dump-bundle` dumps the enclosed http exchanges of a given bundled exchange file in a human readable form.
`dump-bundle` command is a bundle inspector tool. `dump-bundle` dumps the enclosed http exchanges of a given web bundle file in a human readable form.

You are also welcome to use the code as golang lib (e.g. `import "github.com/WICG/webpackage/go/bundle"`), but please be aware that the API is not yet stable and is subject to change any time.

Expand All @@ -27,7 +29,7 @@ go get -u github.com/WICG/webpackage/go/bundle/cmd/...
## Usage

### gen-bundle
`gen-bundle` generates a bundled exchange file. There are three ways to provide a set of exchanges to bundle; by a HAR file, by a URL list, and by a local directory.
`gen-bundle` generates a web bundle. There are three ways to provide a set of exchanges to bundle; by a HAR file, by a URL list, and by a local directory.

These command-line flags are common to all the three options:

Expand All @@ -41,7 +43,7 @@ These command-line flags are common to all the three options:
One convenient way to generate HAR file is via Chrome Devtools. Navigate to "Network" panel, and right-click on any resource and select "Save as HAR with content".
![generating har with devtools](https://raw.githubusercontent.com/WICG/webpackage/master/go/bundle/har-devtools.png)

Once you have the har file, generate the bundled exchange file via:
Once you have the har file, generate the web bundle via:
```
gen-bundle -har foo.har -o foo.wbn -primaryURL https://example.com/
```
Expand Down Expand Up @@ -89,7 +91,8 @@ sign-bundle \
```

### dump-bundle
`dump-bundle` dumps the content of a bundled exchange in a human readable form. To display content of a bundle file, invoke:
`dump-bundle` dumps the content of a web bundle in a human readable form. To
display content of a bundle file, invoke:
```
dump-bundle -i foo.wbn
```
Expand Down
5 changes: 4 additions & 1 deletion js/bundle/README.md
@@ -1,5 +1,8 @@
# Web Bundles
This is a Node.js module for serializing and parsing the `application/webbundle` format defined in the [Bundled HTTP Exchanges](https://wicg.github.io/webpackage/draft-yasskin-wpack-bundled-exchanges.html) draft spec.
This is a Node.js module for serializing and parsing the `application/webbundle`
format defined in the [Web
Bundles](https://wicg.github.io/webpackage/draft-yasskin-wpack-bundled-exchanges.html)
draft spec.

Currently this library doesn't support origin-signed bundles, but bundles generated by this library can be signed with the [`sign-bundle`](https://github.com/WICG/webpackage/tree/master/go/bundle#sign-bundle) Go tool.

Expand Down
2 changes: 1 addition & 1 deletion loading.bs
Expand Up @@ -67,7 +67,7 @@ Assume Explicit For: yes
"Jeffrey Yasskin"
],
"href": "https://wicg.github.io/webpackage/draft-yasskin-wpack-bundled-exchanges.html",
"title": "Bundled HTTP Exchanges",
"title": "Web Bundles",
"status": "ED",
"publisher": "IETF"
},
Expand Down

0 comments on commit 424a50e

Please sign in to comment.