add README

README.md

@@ -0,0 +1,62 @@
+<hr>
+
+**⚠️ Project Archived ⚠️.** This project is archived. I used this for a few
+real projects since 2021 and it was stable, but I've since moved onto using
+[libxev](https://github.com/mitchellh/libxev) so I'm no longer maintaining
+the libuv bindings.
+
+<hr>
+
+# zig-libuv
+
+zig-libuv contains a `build.zig` that can build libuv using Zig and also
+contains a package with Zig bindings. Both can be used together or separately.
+Building libuv with Zig enables easy cross-compilation. The bindings allow
+you to consume libuv easily whether it is built with Zig or not.
+
+## Example 
+
+There are lots of examples in the tests for each individual handle type.
+Below is an example of using a timer, copied exactly from the tests:
+
+```zig
+var loop = try Loop.init(testing.allocator);
+defer loop.deinit(testing.allocator);
+
+var timer = try init(testing.allocator, loop);
+defer timer.deinit(testing.allocator);
+
+var called: bool = false;
+timer.setData(&called);
+try timer.start((struct {
+    fn callback(t: *Timer) void {
+        t.getData(bool).?.* = true;
+        t.close(null);
+    }
+}).callback, 10, 1000);
+
+_ = try loop.run(.default);
+
+try testing.expect(called);
+```
+
+## Usage
+
+To **build libuv:**
+
+```zig
+const libuv = @import("path/to/zig-libuv/build.zig");
+
+pub fn build(b: *std.build.Builder) !void {
+    // ...
+
+    const exe = b.addExecutable("my-program", "src/main.zig");
+    _ = libuv.link(b, exe);
+}
+```
+
+To **use the Zig bindings**, add the package:
+
+```zig
+exe.addPackage(libuv.pkg);
+```