From 5263f2aa1a86a21c99f0497189b79a4d8098d870 Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Mon, 29 Sep 2025 02:45:12 +0800
Subject: [PATCH] README

---
 README.md | 35 +++++++++++++++++++++++++++++++++++

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d2f779eb3e43e34d35d504907baa2d12fd3d6f8b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# hare-aio – asynchronous event loop
+
+Currently, this is an experiment that seeks to see what ergonomic asynchronous
+I/O mechanisms are viable, in particular for truly asynchronous APIs such as
+`io_uring` on Linux. General users who prefer `epoll`-based event loops should
+consider using [hare-ev](https://git.sr.ht/~sircmpwn/hare-ev) instead.
+
+## Acknowedgements
+
+Some of the following projects provided inspiration, some we just lifted code
+from:
+
+* [hare-ev](https://git.sr.ht/~sircmpwn/hare-ev)
+* [hare-iobus](https://git.sr.ht/~sircmpwn/hare-iobus)
+* [hare-linux](https://git.sr.ht/~sircmpwn/hare-linux)
+
+## Contributing
+
+Create a branch that begins with `contrib/` and push to the
+[main repo](https://forge.lindenii.org/hare/:/repos/hare-aio/)
+via SSH directly.
+
+```
+git clone ssh://forge.lindenii.org/hare/:/repos/hare-aio/
+cd hare-aio
+git checkout -b contrib/whatever
+# edit and commit stuff
+git push -u origin HEAD
+```
+
+## Support
+
+[`#chat`](https://webirc.runxiyu.org/gamja/#chat)
+on
+[irc.runxiyu.org](https://irc.runxiyu.org/).

-- 
2.48.1