Skip to content
This repository was archived by the owner on Oct 3, 2025. It is now read-only.

Commit 1663131

Browse files
docs: update documentation
Signed-off-by: Henry Gressmann <mail@henrygressmann.de>
1 parent cdf44f4 commit 1663131

File tree

6 files changed

+38
-20
lines changed

6 files changed

+38
-20
lines changed

Cargo.lock

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div>
22
<div>
3-
<img align="left" src="./tinywasm.png" width="100px">
3+
<a href=""><img align="left" src="./tinywasm.png" width="100px"></a>
44
</div>
55
<h1>TinyWasm</h1>
66
A tiny WebAssembly Runtime written in Rust
@@ -11,7 +11,7 @@
1111
[![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)
1212

1313

14-
> [!WARNING]
14+
> [!WARNING]
1515
> This project is still in development and is not ready for use.
1616
1717
## Features
@@ -38,5 +38,7 @@
3838
# 📄 License
3939

4040
Licensed under either of [Apache License, Version 2.0](./LICENSE-APACHE) or [MIT license](./LICENSE-MIT) at your option.
41+
42+
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.
4143

42-
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.
44+
**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 is because the data is generated from the [WebAssembly Specification](https://github.com/WebAssembly/spec/tree/main/test) and is only used for testing purposes and is not included in the final binary.

crates/types/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# `tinywasm_types`
22

3-
This crate contains the types used by the [`tinywasm`](https://crates.io/crates/tinywasm) crate.
3+
This crate contains the types used by the [`tinywasm`](https://crates.io/crates/tinywasm) crate. It is also used by the [`tinywasm_parser`](https://crates.io/crates/tinywasm_parser) crate to parse WebAssembly binaries.

crates/wasm-testsuite/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
name="wasm-testsuite"
33
version="0.1.0"
44
description="Mirror of the WebAssembly core testsuite for use in testing WebAssembly implementations"
5+
license="Apache-2.0"
6+
readme="README.md"
57
edition.workspace=true
6-
license.workspace=true
78
authors.workspace=true
89
repository.workspace=true
910

crates/wasm-testsuite/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# `wasm-testsuite`
2+
3+
This crate embeds the latest version of the [WebAssembly Test Suite](https://github.com/WebAssembly/spec/tree/main/test). It is currently mainly used for testing the `tinywasm-parser` crate. Check out the [documentation](https://docs.rs/wasm-testsuite) for more information.
4+
5+
## Usage
6+
7+
```rust
8+
use wasm_testsuite::{MVP_TESTS, get_test_wast};
9+
10+
wasm_testsuite::MVP_TESTS.iter().for_each(|test| {
11+
let wast_bytes = get_test_wast(test).expect("Failed to get wast bytes");
12+
let wast = std::str::from_utf8(&wast).expect("failed to convert wast to utf8");
13+
14+
// Do something with the wast (e.g. parse it using the `wast` crate)
15+
});
16+
```
17+
18+
## License
19+
20+
This crate is licensed under the [Apache License, Version 2.0](https://github.com/WebAssembly/spec/blob/main/test/LICENSE).

crates/wasm-testsuite/lib.rs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
//! This crate provides a way to access the WebAssembly spec testsuite.
2-
//!
3-
//! The testsuite is included as a git submodule and embedded into the binary.
4-
//!
5-
//! Generated from <https://github.com/WebAssembly/testsuite>
6-
1+
#![doc = include_str!("README.md")]
72
#![forbid(unsafe_code)]
83
#![doc(test(
94
no_crate_inject,

0 commit comments

Comments
 (0)