From f44ab92299ecf8adb80c944bd2f3c48d4a2c6e0d Mon Sep 17 00:00:00 2001
From: Andy Killorin <37423245+Speedy6451@users.noreply.github.com>
Date: Thu, 19 Dec 2024 12:42:37 -0500
Subject: [PATCH] added readme

---
 readme.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..93895a4
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,9 @@
+# async hot reloading
+
+minimal example of loading an async function from a `.so` and spawning it on the tokio executor. 
+
+the loaded library returns a 
+```rust
+Pin<Box<dyn Future<Output = u64> + Send >>
+```
+which can be sent directly to tokio