docs: link README to top README

- try to fix the error "file not found" during trial to release (but ok with `cargo doc`) Signed-off-by: David Bernard <[email protected]>
cdevents · Sep 1, 2024 · 72b5f37 · 72b5f37
1 parent 9a67c86
commit 72b5f37
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ The SDK can be used to create CDEvents and send them as CloudEvents, as well as
 Import the modules in your code
 
 ```toml
-cdevents = "0.1.0"
+cdevents-sdk = "0.1.0"
 ```
 
 To send a CDEvent as CloudEvent:

diff --git a/cdevents-sdk/Cargo.toml b/cdevents-sdk/Cargo.toml
@@ -8,6 +8,7 @@ publish = true
 repository.workspace = true
 rust-version.workspace = true
 description = "A Rust SDK for CDEvents"
+readme = "README.md"
 
 [dependencies]
 cloudevents-sdk = { version = "0.7", optional = true, default-features = false }

diff --git a/cdevents-sdk/README.md b/cdevents-sdk/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/cdevents-sdk/src/lib.rs b/cdevents-sdk/src/lib.rs
@@ -1,4 +1,4 @@
-#![doc = include_str!("../../README.md")]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
 //#![warn(missing_docs)]
 // TODO remove unwrap(), expect(...)
 // TODO reduce clone()