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)