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