diff --git a/README.md b/README.md index b88cf8b31183..1d07736ce03b 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Hello, world! * **Lightweight**. Wasmtime is a standalone runtime for WebAssembly that scales with your needs. It fits on tiny chips as well as makes use of huge servers. - Wasmtime can be embedded into almost any application too. + Wasmtime can be [embedded] into almost any application too. * **Fast**. Wasmtime is built on the optimizing [Cranelift] code generator to quickly generate high-quality machine code at runtime. @@ -83,6 +83,7 @@ Hello, world! standards process all along the way too. [Cranelift]: https://github.com/bytecodealliance/wasmtime/blob/master/cranelift/README.md +[embedded]: https://bytecodealliance.github.io/wasmtime/embed.html ## Documentation diff --git a/cranelift/README.md b/cranelift/README.md index ce4dec78e64f..bce489b8e0a3 100644 --- a/cranelift/README.md +++ b/cranelift/README.md @@ -59,8 +59,10 @@ Contributing ------------ If you're interested in contributing to Cranelift: thank you! We have a -[contributing guide](CONTRIBUTING.md) which will help you getting involved in -the Cranelift project. +[contributing guide] which will help you getting involved in the Cranelift +project. + +[contributing guide](https://bytecodealliance.github.io/wasmtime/contributing.html) Planned uses ------------ diff --git a/crates/jit/README.md b/crates/jit/README.md index cbf255d893b6..5a35d541bd6d 100644 --- a/crates/jit/README.md +++ b/crates/jit/README.md @@ -2,5 +2,9 @@ This is the `wasmtime-jit` crate, which contains JIT-based execution for wasm, using the wasm ABI defined by [`wasmtime-environ`] and the runtime support provided by [`wasmtime-runtime`]. +Most users will want to use the main [`wasmtime`] crate instead of using this +crate directly. + [`wasmtime-environ`]: https://crates.io/crates/wasmtime-environ [`wasmtime-runtime`]: https://crates.io/crates/wasmtime-runtime +[`wasmtime`]: https://crates.io/crates/wasmtime diff --git a/crates/runtime/README.md b/crates/runtime/README.md index 3e685ad92e3f..4395cd413900 100644 --- a/crates/runtime/README.md +++ b/crates/runtime/README.md @@ -5,6 +5,10 @@ support, supporting the wasm ABI used by [`wasmtime-environ`], This crate does not make a host vs. target distinction; it is meant to be compiled for the target. +Most users will want to use the main [`wasmtime`] crate instead of using this +crate directly. + [`wasmtime-environ`]: https://crates.io/crates/wasmtime-environ [`wasmtime-jit`]: https://crates.io/crates/wasmtime-jit [`wasmtime-obj`]: https://crates.io/crates/wasmtime-obj +[`wasmtime`]: https://crates.io/crates/wasmtime diff --git a/docs/embed-rust.md b/docs/embed-rust.md index 1d194b25b567..e3c4b7501bf9 100644 --- a/docs/embed-rust.md +++ b/docs/embed-rust.md @@ -7,7 +7,7 @@ crate][wasmtime] has to offer and the [book examples for Rust](./examples-rust-embed.md) for more information. [apidoc]: https://bytecodealliance.github.io/wasmtime/api/wasmtime/ -[wasmtime]: https://crates.io/crates/wasmtime +[crate]: https://crates.io/crates/wasmtime ## Creating the WebAssembly to execute diff --git a/docs/embed.md b/docs/embed.md index 92e6b713aff9..ceddd05db217 100644 --- a/docs/embed.md +++ b/docs/embed.md @@ -1,3 +1,10 @@ # Embedding Wasmtime -... more coming soon +Wasmtime can be used as a library to embed WebAssembly execution support +within applications. It has a Rust API, and also supports the official +[WebAssembly C API]. + +* [Rust](embed-rust.md) +* [C](embed-c.md) + +[WebAssembly C API]: https://github.com/WebAssembly/wasm-c-api diff --git a/docs/tutorial.md b/docs/tutorial.md index 3ba6d0fff08e..dc19ed194691 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -1,3 +1,7 @@ # Tutorial -... more coming soon +This tutorial walks through creating a simple Hello World WebAssembly program +and then running it. + +* [Creating `hello-world.wasm`](tutorial-create-hello-world.md) +* [Running `hello-world.wasm`](tutorial-run-hello-world.md)