From 37c348535a45a267c9560c6aedc12012f36ba0d1 Mon Sep 17 00:00:00 2001
From: Erica Marigold <hi@devcomp.xyz>
Date: Fri, 26 Apr 2024 12:19:41 +0530
Subject: [PATCH] chore: include README

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6fc86d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+
+<img align="right" src="https://rusty-luau.devcomp.xyz/logo.png" />
+
+## [read the docs](https://rusty-luau.devcomp.xyz/)
+
+strongly typed implementations of various rust idioms in luau. 
+
+currently, the following implementations are available:
+- [Future](https://rusty-luau.devcomp.xyz/api/Future)
+- [Option](https://rusty-luau.devcomp.xyz/api/Option)
+- [Result](https://rusty-luau.devcomp.xyz/api/Result)