8caa5a9476
* Spice up the project README, fill out more docs This is an attempt to spruce up wasmtime's README.md file as well as fill out more of the missing documentation in the `docs/` folder. There's still a long way to go but I hoped here to mostly move around existing information and add new information. As always happy to have feedback! * Tweak CLI wording * Remove no-longer relevant clause * Update sandboxing docs * Handle comments
100 lines
3.3 KiB
Markdown
100 lines
3.3 KiB
Markdown
<div align="center">
|
|
<h1><code>wasmtime</code></h1>
|
|
|
|
<p>
|
|
<strong>A standalone runtime for
|
|
<a href="https://webassembly.org/">WebAssembly</a></strong>
|
|
</p>
|
|
|
|
<strong>A <a href="https://bytecodealliance.org/">Bytecode Alliance</a> project</strong>
|
|
|
|
<p>
|
|
<a href="https://github.com/bytecodealliance/wasmtime/actions?query=workflow%3ACI"><img src="https://github.com/bytecodealliance/wasmtime/workflows/CI/badge.svg" alt="build status" /></a>
|
|
<a href="https://bytecodealliance.zulipchat.com/#narrow/stream/217126-wasmtime"><img src="https://img.shields.io/badge/zulip-join_chat-brightgreen.svg" alt="zulip chat" /></a>
|
|
<img src="https://img.shields.io/badge/rustc-1.37+-green.svg" alt="min rustc" />
|
|
</p>
|
|
|
|
<h3>
|
|
<a href="https://bytecodealliance.github.io/wasmtime/">Guide</a>
|
|
<span> | </span>
|
|
<a href="https://bytecodealliance.github.io/wasmtime/contributing.html">Contributing</a>
|
|
<span> | </span>
|
|
<a href="https://wasmtime.dev/">Website</a>
|
|
<span> | </span>
|
|
<a href="https://bytecodealliance.zulipchat.com/#narrow/stream/217126-wasmtime">Chat</a>
|
|
</h3>
|
|
</div>
|
|
|
|
## Installation
|
|
|
|
The Wasmtime CLI can be installed on Linux and macOS with a small install
|
|
script:
|
|
|
|
```sh
|
|
$ curl https://wasmtime.dev/install.sh -sSf | bash
|
|
```
|
|
|
|
Windows or otherwise interested users can download installers and
|
|
binaries directly from the [GitHub
|
|
Releases](https://github.com/bytecodealliance/wasmtime/releases) page.
|
|
|
|
## Example
|
|
|
|
If you've got the [Rust compiler
|
|
installed](https://www.rust-lang.org/tools/install) then you can take some Rust
|
|
source code:
|
|
|
|
```rust
|
|
fn main() {
|
|
println!("Hello, world!");
|
|
}
|
|
```
|
|
|
|
and compile/run it with:
|
|
|
|
```sh
|
|
$ rustup target add wasm32-wasi
|
|
$ rustc hello.rs --target wasm32-wasi
|
|
$ wasmtime hello.wasm
|
|
Hello, world!
|
|
```
|
|
|
|
## Features
|
|
|
|
* **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.
|
|
|
|
* **Fast**. Wasmtime is built on the optimizing Cranelift code generator to
|
|
quickly generate high-quality machine code at runtime.
|
|
|
|
* **Configurable**. Whether you need to precompile your wasm ahead of time,
|
|
generate code blazingly fast with Lightbeam, or interpret it at runtime,
|
|
Wasmtime has you covered for all your wasm-executing needs.
|
|
|
|
* **WASI**. Wasmtime supports a rich set of APIs for interacting with the host
|
|
environment through the [WASI standard](https://wasi.dev).
|
|
|
|
* **Standards Compliant**. Wasmtime passes the [official WebAssembly test
|
|
suite](https://github.com/WebAssembly/testsuite), implements the [official C
|
|
API of wasm](https://github.com/WebAssembly/wasm-c-api), and implements
|
|
[future proposals to WebAssembly](https://github.com/WebAssembly/proposals) as
|
|
well. Wasmtime developers are intimately engaged with the WebAssembly
|
|
standards process all along the way too.
|
|
|
|
## Documentation
|
|
|
|
[📚 Read the Wasmtime guide here! 📚][guide]
|
|
|
|
The [wasmtime guide][guide] is the best starting point to learn about what
|
|
Wasmtime can do for you or help answer your questions about Wasmtime. If you're
|
|
curious in contributing to Wasmtime, [it can also help you do
|
|
that][contributing]!.
|
|
|
|
[contributing]: https://bytecodealliance.github.io/wasmtime/contributing.html
|
|
[guide]: https://bytecodealliance.github.io/wasmtime
|
|
|
|
---
|
|
|
|
It's Wasmtime.
|