Skip to content

Commit 72b5f37

Browse files
committed
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 <david.bernard.31@gmail.com>
1 parent 9a67c86 commit 72b5f37

File tree

4 files changed

+4
-2
lines changed

4 files changed

+4
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The SDK can be used to create CDEvents and send them as CloudEvents, as well as
99
Import the modules in your code
1010

1111
```toml
12-
cdevents = "0.1.0"
12+
cdevents-sdk = "0.1.0"
1313
```
1414

1515
To send a CDEvent as CloudEvent:

cdevents-sdk/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ publish = true
88
repository.workspace = true
99
rust-version.workspace = true
1010
description = "A Rust SDK for CDEvents"
11+
readme = "README.md"
1112

1213
[dependencies]
1314
cloudevents-sdk = { version = "0.7", optional = true, default-features = false }

cdevents-sdk/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

cdevents-sdk/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#![doc = include_str!("../../README.md")]
1+
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
22
//#![warn(missing_docs)]
33
// TODO remove unwrap(), expect(...)
44
// TODO reduce clone()

0 commit comments

Comments
 (0)