docs: update readme

Signed-off-by: Henry Gressmann <[email protected]>

Author: explodingcamera

CONTRIBUTING.md

@@ -13,6 +13,12 @@
 - **`cargo test-mvp`**\
   Run the WebAssembly MVP (1.0) test suite. Be sure to cloned this repo with `--recursive` or initialize the submodules with `git submodule update --init --recursive`
 
+- **`cargo test-2`**\
+  Run the full WebAssembly test suite (2.0)
+
+- **`cargo benchmark <benchmark>`**\
+  Run a single benchmark. e.g. `cargo benchmark argon2id`
+
 - **`cargo test-wast <path>`**\
   Run a single WAST test file. e.g. `cargo test-wast ./examples/wast/i32.wast`
 

Cargo.lock

@@ -13,14 +13,14 @@
 ## Why TinyWasm?
 
 - **Tiny**: TinyWasm is designed to be as small as possible without significantly compromising performance or functionality.
-- **Portable**: TinyWasm runs on any platform that LLVM supports, including WebAssembly itself, with minimal external dependencies.
+- **Portable**: TinyWasm runs on any platform that Rust can target, including WebAssembly itself, with minimal external dependencies.
 - **Lightweight**: TinyWasm is easy to integrate and has a low call overhead, making it suitable for scripting and embedding.
 
 ## Status
 
-As of version `0.3.0`, TinyWasm successfully passes all the WebAssembly 1.0 tests in the [WebAssembly Test Suite](https://github.com/WebAssembly/testsuite). Work on the 2.0 tests is ongoing. This achievement ensures that TinyWasm can run most WebAssembly programs, including versions of TinyWasm itself compiled to WebAssembly (see [examples/wasm-rust.rs](./examples/wasm-rust.rs)). The results of the testsuite are available [here](https://github.com/explodingcamera/tinywasm/tree/main/crates/tinywasm/tests/generated).
+As of version `0.3.0`, TinyWasm successfully passes all the WebAssembly 1.0 tests in the [WebAssembly Test Suite](https://github.com/WebAssembly/testsuite). Work on the 2.0 tests is ongoing. This enables TinyWasm to run most WebAssembly programs, including versions of TinyWasm itself compiled to WebAssembly (see [examples/wasm-rust.rs](./examples/wasm-rust.rs)). The results of the testsuites are available [here](https://github.com/explodingcamera/tinywasm/tree/main/crates/tinywasm/tests/generated).
 
-The API is still unstable and may change at any time, so don't use it in production _yet_. Note that TinyWasm isn't primarily designed for high performance; its focus lies more on simplicity, size, and portability. More details on its performance aspects can be found in [BENCHMARKS.md](./BENCHMARKS.md).
+The API is still unstable and may change at any time, so you probably don't want to use it in production _yet_. Note that TinyWasm isn't primarily designed for high performance; its focus lies more on simplicity, size, and portability. More details on its performance aspects can be found in [BENCHMARKS.md](./BENCHMARKS.md).
 
 ## Supported Proposals
 

README.md

@@ -10,20 +10,25 @@
 //! A tiny WebAssembly Runtime written in Rust
 //!
 //! TinyWasm provides a minimal WebAssembly runtime for executing WebAssembly modules.
-//! It currently supports a subset of the WebAssembly MVP specification and is intended
-//! to be useful for embedded systems and other environments where a full-featured
-//! runtime is not required.
+//! It currently supports all features of the WebAssembly MVP specification and is
+//! designed to be easy to use and integrate in other projects.
 //!
 //! ## Features
-//! - `std` (default): Enables the use of `std` and `std::io` for parsing from files and streams.
-//! - `logging` (default): Enables logging via the `log` crate.
-//! - `parser` (default): Enables the `tinywasm_parser` crate for parsing WebAssembly modules.
+//!- **`std`**\
+//!  Enables the use of `std` and `std::io` for parsing from files and streams. This is enabled by default.
+//!- **`logging`**\
+//!  Enables logging using the `log` crate. This is enabled by default.
+//!- **`parser`**\
+//!  Enables the `tinywasm-parser` crate. This is enabled by default.
+//!- **`archive`**\
+//!  Enables pre-parsing of archives. This is enabled by default.
+//!- **`unsafe`**\
+//!  Uses `unsafe` code to improve performance, particularly in Memory access
 //!
-//! ## No-std support
-//! TinyWasm supports `no_std` environments by disabling the `std` feature and registering
-//! a custom allocator. This removes support for parsing from files and streams,
-//! but otherwise the API is the same.
-//! Additionally, to have proper error types, you currently need a `nightly` compiler to have the error trait in core.
+//! With all these features disabled, TinyWasm only depends on `core`, `alloc` and `libm`.
+//! By disabling `std`, you can use TinyWasm in `no_std` environments. This requires
+//! a custom allocator and removes support for parsing from files and streams, but otherwise the API is the same.
+//! Additionally, to have proper error types in `no_std`, you currently need a `nightly` compiler to use the unstable error trait in `core`.
 //!
 //! ## Getting Started
 //! The easiest way to get started is to use the [`Module::parse_bytes`] function to load a