meta: Create Readme.md

1 files changed, 16 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..645c86f
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,16 @@
+# Here is an example of how stdx::opt works.
+
+```cpp
+#include "stdx"
+
+int main(int argc, char** argv)
+{
+  auto opt = stdx::opt(stdx::eval_eq(50, 50)).expect("stdex::eval_eq, does not match!");
+  opt = stdx::opt(stdx::eval_eq(50, 40));
+  opt.expect("this time it doesn't.");
+  
+  return 0;
+}
+```
+
+# Licensed under GPL-2