Skip to content

Commit a590d28

Browse files
committed
Add async to default features, correct and improve documentation
Signed-off-by: Marvin Gudel <marvin.gudel@9elements.com>
1 parent c05b5cb commit a590d28

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

mctp-estack/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ smol = { workspace = true }
3030

3131

3232
[features]
33-
default = ["log"]
33+
default = ["log", "async"]
3434
std = ["mctp/std"]
3535
log = ["dep:log"]
3636
defmt = ["mctp/defmt", "dep:defmt" ]

mctp-estack/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
[API docs](https://docs.rs/mctp-estack)
44

55
This is a MCTP stack suitable for embedded devices.
6-
A `async` Router for embassy based applications is available
7-
through the `embassy` feature.
6+
A `async` Router for [Embassy](https://embassy.dev/) (or other _async runtime_)
7+
based applications is available through the `async` feature.
88

99
A `Router` instance handles feeding MCTP packets to and from user
1010
provided MCTP transports, and handles sending receiving MCTP messages
11-
from applications using the `mctp` crate async traits.
11+
from applications using the `mctp` crate _async_ traits.
1212

1313
Applications using MCTP can create `RouterAsyncListener` and
1414
`RouterAsyncReqChannel` instances.
@@ -20,5 +20,4 @@ and MCTP tag tracking. MCTP transport binding packet encoding and decoding is
2020
provided for I2C, USB, and serial.
2121

2222
## Features
23-
- `embassy`: async `Router` for [Embassy](https://embassy.dev/)
24-
- `async`: [embedded-io-async](https://docs.rs/embedded-io-async/0.6.1/embedded_io_async/) serial transport binding (enabled by `embassy` feature)
23+
- `async`: _async_ router implementing `mctp` crate _async_ traits

mctp-estack/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
//! be passed to applications.
2121
//!
2222
//! ## Features
23-
//! - `async`: [embedded-io-async](https://docs.rs/embedded-io-async/0.6.1/embedded_io_async/) serial transport binding and async Router
23+
//! - `async`: _async_ router implementing [`mctp` crate](mctp) _async_ traits
2424
//!
2525
//! ## Configuration
2626
//!

0 commit comments

Comments
 (0)