From 51d0c63f7e6d65204d6fe4ec3c378ef3fbedf119 Mon Sep 17 00:00:00 2001 From: Henry Gressmann Date: Sun, 28 Jan 2024 14:30:39 +0100 Subject: docs: architecture Signed-off-by: Henry Gressmann --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 57728a4..9fd38ca 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

TinyWasm

A tiny WebAssembly Runtime written in Rust - +
[![docs.rs](https://img.shields.io/docsrs/tinywasm?logo=rust)](https://docs.rs/tinywasm) [![Crates.io](https://img.shields.io/crates/v/tinywasm.svg?logo=rust)](https://crates.io/crates/tinywasm) [![Crates.io](https://img.shields.io/crates/l/tinywasm.svg)](./LICENSE-APACHE) @@ -18,7 +18,6 @@ Some APIs to interact with the runtime are not yet exposed, and the existing one Results of the tests can be found [here](https://github.com/explodingcamera/tinywasm/tree/main/crates/tinywasm/tests/generated). TinyWasm is not designed for performance, but rather for size and portability. However, it is still reasonably fast. -There are a couple of low-hanging fruits on the performance side, but they are not a priority at the moment. ## Supported Proposals @@ -55,9 +54,11 @@ $ cargo add tinywasm Enables logging using the `log` crate. This is enabled by default. - **`parser`**\ Enables the `tinywasm-parser` crate. This is enabled by default. +- **`unsafe`**\ + Uses `unsafe` code to improve performance, particularly in Memory access With all these features disabled, TinyWasm only depends on `core`, `alloc` and `libm` and can be used in `no_std` environments. -Since `libm` is not as performant as the compiler's built-in math intrinsics, it is recommended to use the `std` feature if possible (at least [for now](https://github.com/rust-lang/rfcs/issues/2505)). +Since `libm` is not as performant as the compiler's math intrinsics, it is recommended to use the `std` feature if possible (at least [for now](https://github.com/rust-lang/rfcs/issues/2505)), especially on wasm32 targets. ## Performance -- cgit v1.3.1