Skip to content

Commit 7d1c2ac

Browse files
jbrjbr
authored
an effort at updating the readme tables (#538)
* an effort at updating the readme tables * add package names to the npm package columns
1 parent cef939d commit 7d1c2ac

File tree

1 file changed

+42
-12
lines changed

1 file changed

+42
-12
lines changed

‎README.md

+42-12
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,29 @@
77

88
## Protocol Versions and Release Branches
99

10-
The `main` branch is under continuous development and will usually be partway between DAP and VDAF drafts. divviup-ts uses stable release branches to maintain implementations of different draft versions. Artifacts for some draft version are published from a corresponding `release/dap-draft-xy` branch. Only supported release branches receive dependency updates and backports.
10+
The `main` branch is under continuous development and will usually be partway between DAP and VDAF
11+
drafts. divviup-ts uses stable release branches to maintain implementations of different draft
12+
versions. Artifacts for some draft version are published from a corresponding `release/dap-draft-xy`
13+
branch. Only supported release branches receive dependency updates and backports.
1114

12-
| Package version | Git branch | Protocol version | Conforms to specification? | Status |
13-
| --------------- | ---------- | ------------- | -------------------------- | ------ |
14-
| N/A | `release/dap-draft-02` | [`draft-ietf-ppm-dap-02`][dap-02] | Yes | Unmaintained |
15-
| N/A | `release/dap-draft-03` | [`draft-ietf-ppm-dap-03`][dap-03] | Yes | Unmaintained as of May 22, 2023 |
16-
| 0.1 | `release/dap-draft-04` | [`draft-ietf-ppm-dap-04`][dap-04] | Yes | Supported |
17-
| 0.2 | `main` | [`draft-ietf-ppm-dap-07`][dap-07] | [Partially][dap-07-issue] | Supported |
15+
### DAP
1816

19-
[dap-02]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/02/
20-
[dap-03]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/03/
21-
[dap-04]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/04/
22-
[dap-07]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/07/
23-
[dap-07-issue]: https://github.com/divviup/divviup-ts/issues/359
17+
| Package version | Git branch | Protocol version | Conforms to specification? | Status |
18+
| ----------------------------------- | ----------------------------------- | --------------------------------- | -------------------------- | ------------------------------- |
19+
| N/A | [`release-dap-draft-02`][branch-02] | [`draft-ietf-ppm-dap-02`][dap-02] | Yes | Unmaintained |
20+
| N/A | [`release-dap-draft-03`][branch-03] | [`draft-ietf-ppm-dap-03`][dap-03] | Yes | Unmaintained as of May 22, 2023 |
21+
| [`@divviup/[email protected]`][npm-dap-0.1.0] | [`release-dap-draft-04`][branch-04] | [`draft-ietf-ppm-dap-04`][dap-04] | Yes | Supported |
22+
| [`@divviup/[email protected]`][npm-dap-0.7.0] | [`release-dap-draft-07`][branch-07] | [`draft-ietf-ppm-dap-07`][dap-07] | Yes | Supported |
23+
| | [`main`][main] | [`draft-ietf-ppm-dap-08`][dap-08] | | |
24+
25+
### VDAF and Prio3
26+
27+
| VDAF Package | Prio3 Package | Git branch | Protocol version | Conforms to specification? | Status |
28+
| ------------------------------------- | --------------------------------------- | ----------------------------------- | ------------------------------------ | -------------------------- | ------------------------------- |
29+
| N/A | N/A | [`release/dap-draft-03`][branch-03] | [`draft-irtf-cfrg-vdaf-03`][vdaf-03] | Yes | Unmaintained as of May 22, 2023 |
30+
| [`@divviup/[email protected]`][npm-vdaf-0.1.0] | [`@divviup/[email protected]`][npm-prio3-0.1.0] | [`release/dap-draft-04`][branch-04] | [`draft-irtf-cfrg-vdaf-05`][vdaf-05] | Yes | Supported |
31+
| [`@divviup/[email protected]`][npm-vdaf-0.7.0] | [`@divviup/[email protected]`][npm-prio3-0.7.0] | [`release/dap-draft-07`][branch-07] | [`draft-irtf-cfrg-vdaf-07`][vdaf-07] | Yes | Supported |
32+
| | | [`main`][main] | [`draft-irtf-cfrg-vdaf-08`][vdaf-08] | | |
2433

2534
## Usage
2635

@@ -38,3 +47,24 @@ const task = new Task({
3847

3948
await task.sendMeasurement(42);
4049
```
50+
51+
[npm-vdaf-0.1.0]: https://www.npmjs.com/package/@divviup/vdaf/v/0.1.0
52+
[npm-vdaf-0.7.0]: https://www.npmjs.com/package/@divviup/vdaf/v/0.7.0
53+
[npm-prio3-0.1.0]: https://www.npmjs.com/package/@divviup/prio3/v/0.1.0
54+
[npm-prio3-0.7.0]: https://www.npmjs.com/package/@divviup/prio3/v/0.7.0
55+
[npm-dap-0.1.0]: https://www.npmjs.com/package/@divviup/dap/v/0.1.0
56+
[npm-dap-0.7.0]: https://www.npmjs.com/package/@divviup/dap/v/0.7.0
57+
[vdaf-03]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/03/
58+
[vdaf-05]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/05/
59+
[vdaf-07]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/07/
60+
[vdaf-08]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/08/
61+
[dap-02]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/02/
62+
[dap-03]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/03/
63+
[dap-04]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/04/
64+
[dap-07]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/07/
65+
[dap-08]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/08/
66+
[branch-02]: https://github.com/divviup/divviup-ts/tree/release/dap-draft-02
67+
[branch-03]: https://github.com/divviup/divviup-ts/tree/release/dap-draft-03
68+
[branch-04]: https://github.com/divviup/divviup-ts/tree/release/dap-draft-04
69+
[branch-07]: https://github.com/divviup/divviup-ts/tree/release/dap-draft-07
70+
[main]: https://github.com/divviup/divviup-ts/tree/main

0 commit comments

Comments
 (0)