Skip to content

Commit 97e1422

Browse files
committed
Rewrite README for WASI 0.2 branch
1 parent f4fada2 commit 97e1422

1 file changed

Lines changed: 18 additions & 34 deletions

File tree

README.md

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,25 @@
1-
<img width="100px" src="assets/WASI.png">
1+
# WASI 0.2 docs
22

3-
# WebAssembly System Interface
3+
This branch documents the WASI 0.2 iteration of WASI, also known as Preview 2.
44

5-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4323447.svg)](https://doi.org/10.5281/zenodo.4323447)
6-
5+
WASI 0.2 is a modular collection of APIs defined using the [Wit IDL]. It
6+
incorporates many of the lessons learned from [Preview 1], including support
7+
for a wider range of source languages, modularity, a more expressive type
8+
system, virtualizability, and more. It covers the `wasi:cli`, `wasi:clocks`,
9+
`wasi:filesystem`, `wasi:http`, `wasi:io`, `wasi:random`, and `wasi:sockets`
10+
interfaces at their 0.2.x versions.
711

8-
The WebAssembly System Interface (WASI) is a set of APIs for WASI being
9-
developed for eventual standardization by the WASI Subgroup, which is a
10-
subgroup of the WebAssembly Community Group.
12+
Development of WASI now continues in [WASI 0.3] (Preview 3) on the `main`
13+
branch, which supplants Preview 2 by providing integrated and composable
14+
`async` functionality. Implementations may continue to support WASI 0.2,
15+
either by implementing WASI 0.3 alongside it, or by virtualizing
16+
(polyfilling) 0.2 in terms of 0.3.
1117

12-
WASI started with launching what is now called [Preview 1], an API using
13-
the witx IDL, and it is now widely used. Its major influences are POSIX and
14-
CloudABI.
15-
16-
[WASI Preview 2] is now stable, and is a modular collection of
17-
APIs defined with the [Wit IDL], and it incorporates many of the lessons
18-
learned from Preview 1, including adding support for a wider range of
19-
source languages, modularity, a more expressive type system,
20-
virtualizability, and more.
18+
The proposals included in WASI 0.2 are documented under [`proposals/`](proposals),
19+
and the tagged interface snapshots are under [`specifications/`](specifications).
20+
See [Preview2.md](docs/Preview2.md) for the Preview 2 inclusion criteria and
21+
overview.
2122

2223
[Preview 1]: https://github.com/WebAssembly/WASI/tree/wasi-0.1
23-
[WASI Preview 2]: https://github.com/WebAssembly/WASI/blob/main/docs/Preview2.md
24+
[WASI 0.3]: https://github.com/WebAssembly/WASI/tree/main
2425
[Wit IDL]: https://github.com/WebAssembly/component-model/blob/main/design/mvp/WIT.md
25-
26-
## Find the APIs
27-
28-
Development of each API happens in its own repo, which you can access
29-
from the [proposals list](docs/Proposals.md).
30-
31-
This repo is for general discussion, as well as documenting how we work
32-
and high-level goals.
33-
34-
## Propose a new API
35-
36-
If you would like to create a new proposal, get started with our
37-
[Contributing guide](CONTRIBUTING.md).
38-
39-
All new API proposals should use the new format and the new repo structure that is shown in the [proposal template](https://github.com/WebAssembly/wasi-proposal-template).
40-
41-
See the [Wit in WASI](docs/WitInWasi.md) document for more information about using Wit for WASI proposals.

0 commit comments

Comments
 (0)