meta: update README with a brief and better code snippet.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8cc6e76
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Amlal's Standard Extended
+
+[![License: GPL-2.0](https://img.shields.io/badge/license-GPL--2.0-blue.svg)](LICENSE)
+
+## Brief:
+
+A C++ library with additional modules for your C++ SDLC.
+
+## Getting Started:
+
+Here is an example of how astdx::opt works.
+
+```cpp
+#include <astdx/opt.hpp>
+
+int main(int argc, char** argv)
+{
+  auto opt = astdx::opt(astdx::eval_eq(50, 50)).expect("astdx::eval_eq, does not match!");
+  opt = astdx::opt(astdx::eval_eq(50, 40));
+  opt.expect("this time it doesn't.");
+  
+  return 0;
+}
+```
+