diff --git a/crates/iron-remote-desktop/Cargo.toml b/crates/iron-remote-desktop/Cargo.toml index 769f60d0..a7611c09 100644 --- a/crates/iron-remote-desktop/Cargo.toml +++ b/crates/iron-remote-desktop/Cargo.toml @@ -1,6 +1,8 @@ [package] name = "iron-remote-desktop" version = "0.1.0" +readme = "README.md" +description = "Helper crate for building WASM modules compatible with iron-remote-desktop WebComponent" edition.workspace = true license.workspace = true homepage.workspace = true diff --git a/crates/iron-remote-desktop/README.md b/crates/iron-remote-desktop/README.md new file mode 100644 index 00000000..4ac80083 --- /dev/null +++ b/crates/iron-remote-desktop/README.md @@ -0,0 +1,6 @@ +# Iron Remote Desktop — Helper Crate + +Helper crate for building WASM modules compatible with the `iron-remote-desktop` WebComponent. + +Implement the `RemoteDesktopApi` on a Rust type, and call the `make_bridge!` on +it to generate the WASM API that is expected by `iron-remote-desktop`. diff --git a/crates/iron-remote-desktop/src/lib.rs b/crates/iron-remote-desktop/src/lib.rs index 5640fb62..1961d086 100644 --- a/crates/iron-remote-desktop/src/lib.rs +++ b/crates/iron-remote-desktop/src/lib.rs @@ -1,3 +1,6 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://cdnweb.devolutions.net/images/projects/devolutions/logos/devolutions-icon-shadow.svg")] + mod clipboard; mod cursor; mod desktop_size;