From 2b75b461fe3972a273b74cc3c0a1e94991b673a7 Mon Sep 17 00:00:00 2001 From: Filip Tibell Date: Sun, 11 Feb 2024 10:41:27 +0100 Subject: [PATCH] Clarify compatibility in readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7f4453..f98fb97 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,16 @@
-Luau-based async runtime, using [`mlua`](https://crates.io/crates/mlua) and [`async-executor`](https://crates.io/crates/async-executor). +An async runtime for Luau, using [`mlua`][mlua] and built on top of [`async-executor`][async-executor]. + +This crate is runtime-agnostic and is compatible with any async runtime, including [Tokio][tokio], [smol][smol], [async-std][async-std], and others.
+However, since many dependencies are shared with [smol][smol], depending on it over other runtimes may be preferred. + +[async-executor]: https://crates.io/crates/async-executor +[async-std]: https://async.rs +[mlua]: https://crates.io/crates/mlua +[smol]: https://github.com/smol-rs/smol +[tokio]: https://tokio.rs ## Example Usage