summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHenry Gressmann <mail@henrygressmann.de>2025-01-14 17:41:29 +0100
committerHenry Gressmann <mail@henrygressmann.de>2025-01-14 17:41:29 +0100
commit40e570cf8bdd948c1e7e9dd85e5ac24d9a062d2a (patch)
tree64e9338f1c656fd9d81f51cd4f425359b2dbc6d1 /README.md
parent1a64f4092af9304694e98f441b79f0a93ee1c194 (diff)
chore: update deps, spelling
Signed-off-by: Henry Gressmann <mail@henrygressmann.de>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/README.md b/README.md
index a963ea7..8db5a84 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
- **Tiny**: TinyWasm is designed to be as small as possible without significantly compromising performance or functionality (< 4000 LLOC).
- **Portable**: TinyWasm runs on any platform that Rust can target, including `no_std`, with minimal external dependencies.
-- **Safe**: No unsafe code is used in the runtime (`rkyv` which uses unsafe code can be used for serialization, but is optional).
+- **Safe**: No unsafe code is used in the runtime (`rkyv`, which uses unsafe code, can be used for serialization but is optional).
## Status
@@ -24,7 +24,7 @@ TinyWasm passes all WebAssembly MVP tests from the [WebAssembly core testsuite](
**Legend**\
🌑 -- not available\
-🚧 -- in development / partialy supported\
+🚧 -- in development/partially supported\
🟢 -- fully supported
| Proposal | Status | TinyWasm Version |
@@ -61,24 +61,21 @@ $ tinywasm-cli --help
- **`archive`**\
Enables pre-parsing of archives. This is enabled by default.
-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 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.
+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 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.
## Inspiration
Big thanks to the authors of the following projects, which have inspired and influenced TinyWasm:
-- [wasmi](https://github.com/wasmi-labs/wasmi) - an efficient and lightweight WebAssembly interpreter that also runs on `no_std` environments
-- [wasm3](https://github.com/wasm3/wasm3) - a high performance WebAssembly interpreter written in C
-- [wazero](https://wazero.io/) - a zero-dependency WebAssembly interpreter written in go
+- [wasmi](https://github.com/wasmi-labs/wasmi) - an efficient and lightweight WebAssembly interpreter that also runs in `no_std` environments
+- [wasm3](https://github.com/wasm3/wasm3) - a high-performance WebAssembly interpreter written in C
+- [wazero](https://wazero.io/) - a zero-dependency WebAssembly interpreter written in Go
- [wain](https://github.com/rhysd/wain) - a zero-dependency WebAssembly interpreter written in Rust
-I encourage you to check these projects out if you're looking for more mature and feature-complete WebAssembly Runtimes.
+I encourage you to check these projects out if you're looking for more mature and feature-complete WebAssembly runtimes.
## License
Licensed under either of [Apache License, Version 2.0](./LICENSE-APACHE) or [MIT license](./LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in TinyWasm by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
-
-**Note:** The GitHub repository contains a Submodule (`crates/tinywasm-parser/data`) which is licensed only under the [Apache License, Version 2.0](https://github.com/WebAssembly/spec/blob/main/test/LICENSE). This data is generated from the [WebAssembly Specification](https://github.com/WebAssembly/spec/tree/main/test) and is only used for testing purposes and not included in the final binary.