Skip to content

Commit

Permalink
release prep
Browse files Browse the repository at this point in the history
  • Loading branch information
guybedford committed Sep 5, 2024
1 parent 814bdc0 commit 75843fe
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ As more components are written in JavaScript, and there exist scenarios where mu

Establishing this initial prototype as a singular flexible engine foundation that can be turned into a shared library is therefore the focus for this project.

### Weval AOT Compilation



## Platform APIs

The following APIs are available:
Expand Down Expand Up @@ -98,8 +102,14 @@ const { component } = await componentize(`
await writeFile('test.component.wasm', component);
```

See [types.d.ts](types.d.ts) for the full interface options.

The component iself can be executed in any component runtime, see the [example](EXAMPLE.md) for an end to end workflow in Wasmtime.

### AOT Compilation

To enable AOT compilation, set the `enableAot: true` option to run [Weval](https://github.com/cfallin/weval) ahead-of-time compilation.

### Async Support

To support asynchronous operations, all functions may optionally be written as sync or async functions, even though they will always be turned into sync component functions.
Expand Down

0 comments on commit 75843fe

Please sign in to comment.