From bab049aa0068ff4f44fed02a241f166cd97878cb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Beno=C3=AEt=20Cortier?= <bcortier@proton.me>
Date: Wed, 20 Nov 2024 20:15:29 +0900
Subject: [PATCH] docs(ironrdp): README.md dedicated to the meta crate (#582)

Using the top-level README.md of the repository is not ideal.

1/ It contains many information unrelated to the meta crate itself.

2/ The following attribute:

```
 #![doc = include_str!("../../../README.md")]
```

will fail at finding the README.md when built via `cargo package`.
---
 Cargo.toml                | 1 -
 crates/ironrdp/Cargo.toml | 4 ++--
 crates/ironrdp/README.md  | 7 +++++++
 crates/ironrdp/src/lib.rs | 2 +-
 4 files changed, 10 insertions(+), 4 deletions(-)
 create mode 100644 crates/ironrdp/README.md

diff --git a/Cargo.toml b/Cargo.toml
index 98f1ca64..413eaf26 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -14,7 +14,6 @@ exclude = [
 ]
 
 [workspace.package]
-readme = "README.md"
 edition = "2021"
 license = "MIT/Apache-2.0"
 homepage = "https://github.com/Devolutions/IronRDP"
diff --git a/crates/ironrdp/Cargo.toml b/crates/ironrdp/Cargo.toml
index d86c69ab..f601f429 100644
--- a/crates/ironrdp/Cargo.toml
+++ b/crates/ironrdp/Cargo.toml
@@ -1,8 +1,8 @@
 [package]
 name = "ironrdp"
 version = "0.5.0"
-description = "A Rust implementation of the Microsoft Remote Desktop Protocol (RDP)"
-readme.workspace = true
+readme = "README.md"
+description = "A meta crate re-exporting IronRDP crates for convenience"
 edition.workspace = true
 license.workspace = true
 homepage.workspace = true
diff --git a/crates/ironrdp/README.md b/crates/ironrdp/README.md
new file mode 100644
index 00000000..651395d8
--- /dev/null
+++ b/crates/ironrdp/README.md
@@ -0,0 +1,7 @@
+# IronRDP meta crate
+
+A meta crate re-exporting IronRDP crates for convenience.
+
+This crate is part of the [IronRDP] project.
+
+[IronRDP]: https://github.com/Devolutions/IronRDP
diff --git a/crates/ironrdp/src/lib.rs b/crates/ironrdp/src/lib.rs
index 43588e20..ff757e14 100644
--- a/crates/ironrdp/src/lib.rs
+++ b/crates/ironrdp/src/lib.rs
@@ -1,4 +1,4 @@
-#![doc = include_str!("../../../README.md")]
+#![doc = include_str!("../README.md")]
 #![doc(
     html_logo_url = "https://webdevolutions.blob.core.windows.net/images/projects/devolutions/logos/devolutions-icon-shadow.svg"
 )]