Skip to content

Commit a099aa5

Browse files
authored
Add some more words to the README (#1835)
* Add an example of `wasm-tools parse` * Add a listing of implemented WebAssembly proposals.
1 parent 2138a27 commit a099aa5

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $ wasm-tools help
4545

4646
# Examples
4747

48-
Basic validation/printing:
48+
Basic validation/printing/parsing:
4949

5050
```sh
5151
# Validate a WebAssembly file
@@ -66,6 +66,9 @@ $ wasm-tools print foo.wasm
6666

6767
# Convert a binary module to text
6868
$ wasm-tools print foo.wasm -o foo.wat
69+
70+
# Convert a text module to binary
71+
$ wasm-tools parse foo.wat -o foo.wasm
6972
```
7073

7174
Simple mutation as well as piping commands together:
@@ -168,6 +171,45 @@ The `wasm-tools` CLI contains useful tools for debugging WebAssembly modules and
168171
components. The various subcommands all have `--help` explainer texts to
169172
describe more about their functionality as well.
170173

174+
# WebAssembly proposals
175+
176+
This repository strives to implement any standardized proposal to WebAssembly.
177+
All proposals that are [Stage 4+](https://github.com/WebAssembly/proposals) are
178+
enabled by default in validation. Support in the text format is always enabled
179+
at all times for all proposals.
180+
181+
Currently implemented proposals in this repository that are stage 4+ are:
182+
183+
* [x] [annotations](https://github.com/WebAssembly/annotations)
184+
* [x] [branch-hinting](https://github.com/WebAssembly/branch-hinting)
185+
* [x] [bulk-memory](https://github.com/WebAssembly/bulk-memory-operations)
186+
* [x] [exceptions](https://github.com/WebAssembly/exceptions)
187+
* [x] [extended-const](https://github.com/WebAssembly/extended-const)
188+
* [x] [function-references](https://github.com/WebAssembly/function-references)
189+
* [x] [gc](https://github.com/WebAssembly/gc)
190+
* [x] [memory64](https://github.com/WebAssembly/memory64)
191+
* [x] [multi-memory](https://github.com/WebAssembly/multi-memory)
192+
* [x] [multi-value](https://github.com/WebAssembly/multi-value)
193+
* [x] [mutable-global](https://github.com/WebAssembly/mutable-global)
194+
* [x] [reference-types](https://github.com/WebAssembly/reference-types)
195+
* [x] [relaxed-simd](https://github.com/WebAssembly/relaxed-simd)
196+
* [x] [saturating-float-to-int](https://github.com/WebAssembly/nontrapping-float-to-int-conversions)
197+
* [x] [sign-extension-ops](https://github.com/WebAssembly/sign-extension-ops)
198+
* [x] [simd](https://github.com/WebAssembly/simd)
199+
* [x] [tail-call](https://github.com/WebAssembly/tail-call)
200+
* [x] [threads](https://github.com/WebAssembly/threads)
201+
202+
These proposals are implemented but have not yet reached stage 4. This means
203+
they are disabled by default in validation and their implementation may change
204+
over time as the proposal evolves. Additionally the proposal may also have
205+
changed since these proposals were implemented, so there may be a mismatch too.
206+
207+
* [x] [component-model](https://github.com/WebAssembly/component-model)
208+
* [x] [custom-page-sizes](https://github.com/WebAssembly/custom-page-sizes)
209+
* [x] [memory-control](https://github.com/WebAssembly/memory-control)
210+
* [x] [shared-everything-threads](https://github.com/WebAssembly/shared-everything-threads)
211+
* [x] [stack-switching](https://github.com/WebAssembly/stack-switching)
212+
171213
# Libraries
172214

173215
As mentioned above many of the tools of the `wasm-tools` CLI have libraries

0 commit comments

Comments
 (0)