From d08750034a582b7ef338432a360c62a2969f6aa0 Mon Sep 17 00:00:00 2001 From: Henry Gressmann Date: Sat, 9 Dec 2023 14:56:03 +0100 Subject: chore: improve documentation Signed-off-by: Henry Gressmann --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 257902d..a9022a5 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,21 @@
-[![docs.rs](https://img.shields.io/docsrs/okv?logo=rust)](https://docs.rs/okv) [![Crates.io](https://img.shields.io/crates/v/okv.svg?logo=rust)](https://crates.io/crates/okv) [![Crates.io](https://img.shields.io/crates/l/okv.svg)](./LICENSE-APACHE) +[![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] > This project is still in development and is not ready for use. +## Features + +- **`std`**\ + Enables the use of `std` and `std::io` for parsing from files and streams. This is enabled by default. +- **`logging`**\ + Enables logging of the parsing process using the `log` crate. This is enabled by default. +- **`parser`**\ + Enables the `tinywasm_parser` crate. This is enabled by default. + # 🎯 Goals * Interpreted Runtime (no JIT) -- cgit v1.3.1