summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenry Gressmann <mail@henrygressmann.de>2023-11-29 13:57:04 +0100
committerHenry Gressmann <mail@henrygressmann.de>2023-11-29 13:57:04 +0100
commit4f13c2518133c35db8533bd736ce5497105e2e10 (patch)
treef409d0a3e781b4e58d946224b5a5894f72d6e637
parent276188c695d30e81150c3f0dbf42935cacaba998 (diff)
docs: update readme
Signed-off-by: Henry Gressmann <mail@henrygressmann.de>
-rw-r--r--.gitignore1
-rw-r--r--README.md22
2 files changed, 20 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore
index ea8c4bf..85d7b07 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
/target
+notes.md \ No newline at end of file
diff --git a/README.md b/README.md
index aca28d6..d03a63d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,23 @@
-# TinyWasm
+<div align="center">
+ <h1 align="center"> TinyWasm</h1>
+ <h3 align="center">A tiny, interpreted WebAssembly Runtime written in Rust.</h3>
+</div>
-# License
+> [!WARNING]
+> This project is still in development and is not ready for use.
+
+# 🎯 Goals
+
+* [ ] No unsafe code
+* [ ] Works on `no_std` (with `alloc` the feature and nightly compiler)
+* [ ] Fully support WebAssembly MVP
+* [ ] Optimize memory usage for embedded devices
+* [ ] Optimize performance
+* [ ] Wasm Spec Test Suite
+* [ ] Preemptive multitasking support
+
+# 📄 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 OKV 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
+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