Skip to content

Commit

Permalink
Fix links in and tidy up README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukewagner committed Jul 3, 2024
1 parent da64ad5 commit 2a3a6dd
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,42 @@
# Component Model design and specification

This repository is where the component model is being standardized. For a more user-focused explanation, take a look at the **[Component Model Documentation]**.
This repository is where the component model is being standardized. For a more
user-focused explanation, take a look at the **[Component Model Documentation]**.

This repository contains the high-level [goals], [use cases], [design choices]
and [FAQ] of the component model as well as a more-detailed, low-level
[AST explainer], [async explainer], [IDL], [binary format] and [ABI] covering
the initial Minimum Viable Product (MVP) release.
and [FAQ] of the Component Model as well as more-detailed, low-level explainer
docs describing the [IDL], [text format], [binary format], [concurrency model]
and [Canonical ABI].

In the future, this repository will additionally contain a [formal spec],
reference interpreter and test suite.

## Milestones

The Component Model is currently being incrementally developed and stabilized
as part of [WASI Preview 2]. The subsequent "Preview 3" milestone will be
primarily concerned with the addition of [async support].
as part of [WASI Preview 2]. The subsequent [WASI Preview 3] milestone will be
primarily concerned with the addition of [async support][Concurrency Model].

## Contributing

All Component Model work is done as part of the [W3C WebAssembly Community Group].
To contribute to any of these repositories, see the Community Group's
[Contributing Guidelines].


[Component Model Documentation]: https://component-model.bytecodealliance.org/
[goals]: design/high-level/Goals.md
[use cases]: design/high-level/UseCases.md
[design choices]: design/high-level/Choices.md
[Goals]: design/high-level/Goals.md
[Use Cases]: design/high-level/UseCases.md
[Design Choices]: design/high-level/Choices.md
[FAQ]: design/high-level/FAQ.md
[AST explainer]: design/mvp/Explainer.md
[async explainer]: design/mvp/Async.md
[IDL]: design/mvp/WIT.md
[binary format]: design/mvp/Binary.md
[ABI]: design/mvp/CanonicalABI.md
[Text Format]: design/mvp/Explainer.md
[Binary Format]: design/mvp/Binary.md
[Concurrency Model]: design/mvp/Async.md
[Canonical ABI]: design/mvp/CanonicalABI.md
[formal spec]: spec/
[W3C WebAssembly Community Group]: https://www.w3.org/community/webassembly/
[Contributing Guidelines]: https://webassembly.org/community/contributing/
[WASI Preview 2]: https://github.com/WebAssembly/WASI/tree/main/preview2
[WASI Preview 3]: https://github.com/WebAssembly/WASI/tree/main/preview2#looking-forward-to-preview-3
[Async Support]: https://docs.google.com/presentation/d/1MNVOZ8hdofO3tI0szg_i-Yoy0N2QPU2C--LzVuoGSlE/edit?usp=share_link

0 comments on commit 2a3a6dd

Please sign in to comment.