From bc56d7303a938170cf74d4860cae49ad23e6a451 Mon Sep 17 00:00:00 2001
From: Benjamin Eckel <bhelx@users.noreply.github.com>
Date: Wed, 4 Oct 2023 16:33:54 -0500
Subject: [PATCH] docs: Add readme, bump convert crate (#495)

Co-authored-by: zach <zach@dylibso.com>
---
 convert/Cargo.toml |  3 ++-
 convert/README.md  | 12 ++++++++++++
 convert/src/lib.rs |  2 +-
 runtime/Cargo.toml |  2 +-
 4 files changed, 16 insertions(+), 3 deletions(-)
 create mode 100644 convert/README.md

diff --git a/convert/Cargo.toml b/convert/Cargo.toml
index d01fb77..d12ee0e 100644
--- a/convert/Cargo.toml
+++ b/convert/Cargo.toml
@@ -1,9 +1,10 @@
 [package]
 name = "extism-convert"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = ["The Extism Authors", "oss@extism.org"]
 license = "BSD-3-Clause"
+readme = "./README.md"
 homepage = "https://extism.org"
 repository = "https://github.com/extism/extism"
 description = "Traits to make Rust types usable with Extism"
diff --git a/convert/README.md b/convert/README.md
new file mode 100644
index 0000000..284a4d5
--- /dev/null
+++ b/convert/README.md
@@ -0,0 +1,12 @@
+# extism-convert
+
+The [extism-convert](https://crates.io/crates/extism-convert) crate is used by the [Rust SDK](https://crates.io/crates/extism) and [Rust PDK](https://crates.io/crates/extism-pdk) to provide a shared interface for
+encoding and decoding values that can be passed to Extism function calls.
+
+A set of types (Json, Msgpack, Protobuf) that can be used to specify a serde encoding are also provided. These are
+similar to [axum extractors](https://docs.rs/axum/latest/axum/extract/index.html#intro) - they are
+implemented as a tuple struct with a single field that is meant to be extracted using pattern matching.
+
+## Documentation
+
+See [extism-convert on docs.rs](https://docs.rs/extism-convert/latest/extism_convert/) for in-depth documentation.
diff --git a/convert/src/lib.rs b/convert/src/lib.rs
index 6a568b4..53c88de 100644
--- a/convert/src/lib.rs
+++ b/convert/src/lib.rs
@@ -1,4 +1,4 @@
-//! The `extism-convert` crate is used by the SDK and PDK to provide a shared interface for
+//! The [extism-convert](https://crates.io/crates/extism-convert) crate is used by the [Rust SDK](https://crates.io/crates/extism) and [Rust PDK](https://crates.io/crates/extism-pdk) to provide a shared interface for
 //! encoding and decoding values that can be passed to Extism function calls.
 //!
 //! A set of types (Json, Msgpack) that can be used to specify a serde encoding are also provided. These are
diff --git a/runtime/Cargo.toml b/runtime/Cargo.toml
index e8e1ff9..e6715b0 100644
--- a/runtime/Cargo.toml
+++ b/runtime/Cargo.toml
@@ -22,7 +22,7 @@ url = "2"
 glob = "0.3"
 ureq = {version = "2.5", optional=true}
 extism-manifest = { version = "1.0.0-alpha.0", path = "../manifest" }
-extism-convert = { version = "0.1", path = "../convert" }
+extism-convert = { version = "0.2", path = "../convert" }
 uuid = { version = "1", features = ["v4"] }
 libc = "0.2"