Add readme

joshuajaco · Jul 5, 2022 · cc35b7d · cc35b7d
1 parent b1df369
commit cc35b7d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# resulted [![Coverage Status](https://coveralls.io/repos/github/joshuajaco/resulted/badge.svg?branch=main)](https://coveralls.io/github/joshuajaco/resulted?branch=main) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+A tiny typescript result object implementation based on Rust's [std::result::Result](https://doc.rust-lang.org/std/result/enum.Result.html) enum.
+
+# License
+
+[MIT](https://github.com/joshuajaco/resulted/blob/main/LICENSE)