diff options
Diffstat (limited to 'embassy-net-driver/README.md')
| -rw-r--r-- | embassy-net-driver/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/embassy-net-driver/README.md b/embassy-net-driver/README.md index 84f25492d..6a757380d 100644 --- a/embassy-net-driver/README.md +++ b/embassy-net-driver/README.md | |||
| @@ -1,5 +1,21 @@ | |||
| 1 | # embassy-net-driver | 1 | # embassy-net-driver |
| 2 | 2 | ||
| 3 | This crate contains the driver trait necessary for adding [`embassy-net`](https://crates.io/crates/embassy-net) support | ||
| 4 | for a new hardware platform. | ||
| 5 | |||
| 6 | If you want to *use* `embassy-net` with already made drivers, you should depend on the main `embassy-net` crate, not on this crate. | ||
| 7 | |||
| 8 | If you are writing a driver, you should depend only on this crate, not on the main `embassy-net` crate. | ||
| 9 | This will allow your driver to continue working for newer `embassy-net` major versions, without needing an update, | ||
| 10 | if the driver trait has not had breaking changes. | ||
| 11 | |||
| 12 | See also [`embassy-net-driver-channel`](https://crates.io/crates/embassy-net-driver-channel), which provides a higer-level API | ||
| 13 | to construct a driver that processes packets in its own background task and communicates with the `embassy-net` task via | ||
| 14 | packet queues for RX and TX. | ||
| 15 | |||
| 16 | ## Interoperability | ||
| 17 | |||
| 18 | This crate can run on any executor. | ||
| 3 | 19 | ||
| 4 | ## License | 20 | ## License |
| 5 | 21 | ||
