aboutsummaryrefslogtreecommitdiff
path: root/embassy-executor-timer-queue/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'embassy-executor-timer-queue/README.md')
-rw-r--r--embassy-executor-timer-queue/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/embassy-executor-timer-queue/README.md b/embassy-executor-timer-queue/README.md
new file mode 100644
index 000000000..602aca7b1
--- /dev/null
+++ b/embassy-executor-timer-queue/README.md
@@ -0,0 +1,10 @@
1# embassy-executor-time-queue
2
3This crate defines the timer queue item that embassy-executor provides, and a way to access it, for
4executor-integrated timer queues. The crate decouples the release cycle of embassy-executor from
5that of the queue implementations'.
6
7As a HAL implementer, you only need to depend on this crate if you want to implement executor-integrated
8timer queues yourself, without using [`embassy-time-queue-utils`](https://crates.io/crates/embassy-time-queue-utils).
9
10As a HAL user, you should not need to depend on this crate.