docs: update documentation

Signed-off-by: Henry Gressmann <mail@henrygressmann.de>

6 files changed, 38 insertions, 20 deletions

diff --git a/Cargo.lock b/Cargo.lock
index c76a02c..d8b151c 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -56,7 +56,7 @@ dependencies = [
  "argh_shared",
  "proc-macro2",
  "quote",
- "syn 2.0.39",
+ "syn 2.0.40",
 ]
 
 [[package]]
@@ -330,9 +330,9 @@ checksum = "884e2677b40cc8c339eaefcb701c32ef1fd2493d71118dc0ca4b6a736c93bd67"
 
 [[package]]
 name = "libc"
-version = "0.2.150"
+version = "0.2.151"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "89d92a4743f9a61002fae18374ed11e7973f530cb3a3255fb354818118b2203c"
+checksum = "302d7ab3130588088d277783b1e2d2e10c9e9e4a16dd9050e6ec93fb3e7048f4"
 
 [[package]]
 name = "linux-raw-sys"
@@ -522,7 +522,7 @@ dependencies = [
  "proc-macro2",
  "quote",
  "rust-embed-utils",
- "syn 2.0.39",
+ "syn 2.0.40",
  "walkdir",
 ]
 
@@ -545,9 +545,9 @@ checksum = "d626bb9dae77e28219937af045c257c28bfd3f69333c512553507f5f9798cb76"
 
 [[package]]
 name = "rustix"
-version = "0.38.27"
+version = "0.38.28"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bfeae074e687625746172d639330f1de242a178bf3189b51e35a7a21573513ac"
+checksum = "72e572a5e8ca657d7366229cdde4bd14c4eb5499a9573d4d366fe1b599daa316"
 dependencies = [
  "bitflags",
  "errno",
@@ -588,7 +588,7 @@ checksum = "43576ca501357b9b071ac53cdc7da8ef0cbd9493d8df094cd821777ea6e894d3"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.39",
+ "syn 2.0.40",
 ]
 
 [[package]]
@@ -621,9 +621,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "2.0.39"
+version = "2.0.40"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "23e78b90f2fcf45d3e842032ce32e3f2d1545ba6636271dcbf24fa306d87be7a"
+checksum = "13fa70a4ee923979ffb522cacce59d34421ebdea5625e1073c4326ef9d2dd42e"
 dependencies = [
  "proc-macro2",
  "quote",
diff --git a/README.md b/README.md
index f51c8ee..7167cda 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 <div>
     <div>
-        <img align="left" src="./tinywasm.png" width="100px">
+        <a href=""><img align="left" src="./tinywasm.png" width="100px"></a>
     </div>
     <h1>TinyWasm</h1>
     A tiny WebAssembly Runtime written in Rust
@@ -11,7 +11,7 @@
 [![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) 
 
 
-> [!WARNING]  
+> [!WARNING]
 > This project is still in development and is not ready for use.
 
 ## Features
@@ -38,5 +38,7 @@
 # 📄 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.
 
-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. 
\ No newline at end of file
+**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.
diff --git a/crates/types/README.md b/crates/types/README.md
index 0aecbcc..f2d048b 100644
--- a/crates/types/README.md
+++ b/crates/types/README.md
@@ -1,3 +1,3 @@
 # `tinywasm_types`
 
-This crate contains the types used by the [`tinywasm`](https://crates.io/crates/tinywasm) crate.
\ No newline at end of file
+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.
diff --git a/crates/wasm-testsuite/Cargo.toml b/crates/wasm-testsuite/Cargo.toml
index 68f2355..30a4e58 100644
--- a/crates/wasm-testsuite/Cargo.toml
+++ b/crates/wasm-testsuite/Cargo.toml
@@ -2,8 +2,9 @@
 name="wasm-testsuite"
 version="0.1.0"
 description="Mirror of the WebAssembly core testsuite for use in testing WebAssembly implementations"
+license="Apache-2.0"
+readme="README.md"
 edition.workspace=true
-license.workspace=true
 authors.workspace=true
 repository.workspace=true
 
diff --git a/crates/wasm-testsuite/README.md b/crates/wasm-testsuite/README.md
new file mode 100644
index 0000000..c3dcde2
--- /dev/null
+++ b/crates/wasm-testsuite/README.md
@@ -0,0 +1,20 @@
+# `wasm-testsuite`
+
+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.
+
+## Usage
+
+```rust
+use wasm_testsuite::{MVP_TESTS, get_test_wast};
+
+wasm_testsuite::MVP_TESTS.iter().for_each(|test| {
+    let wast_bytes = get_test_wast(test).expect("Failed to get wast bytes");
+    let wast = std::str::from_utf8(&wast).expect("failed to convert wast to utf8");
+
+    // Do something with the wast (e.g. parse it using the `wast` crate)
+});
+```
+
+## License
+
+This crate is licensed under the [Apache License, Version 2.0](https://github.com/WebAssembly/spec/blob/main/test/LICENSE).
\ No newline at end of file
diff --git a/crates/wasm-testsuite/lib.rs b/crates/wasm-testsuite/lib.rs
index 7e6afb4..9e38bfc 100644
--- a/crates/wasm-testsuite/lib.rs
+++ b/crates/wasm-testsuite/lib.rs
@@ -1,9 +1,4 @@
-//! This crate provides a way to access the WebAssembly spec testsuite.
-//!
-//! The testsuite is included as a git submodule and embedded into the binary.
-//!
-//! Generated from <https://github.com/WebAssembly/testsuite>
-
+#![doc = include_str!("README.md")]
 #![forbid(unsafe_code)]
 #![doc(test(
     no_crate_inject,