From f85c4ecaea1efe3591ea3eb340a3d3468c71d98b Mon Sep 17 00:00:00 2001
From: Amlal El Mahrouss <amlal@nekernel.org>
Date: Mon, 31 Mar 2025 13:25:30 +0200
Subject: meta: update README with a brief and better code snippet.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
---
 README.md | 25 +++++++++++++++++++++++++
 ReadMe.md | 22 ----------------------
 2 files changed, 25 insertions(+), 22 deletions(-)
 create mode 100644 README.md
 delete mode 100644 ReadMe.md

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;
+}
+```
+
diff --git a/ReadMe.md b/ReadMe.md
deleted file mode 100644
index 788a2b0..0000000
--- a/ReadMe.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# Amlal's Standard Extended
-
-[![License: GPL-2.0](https://img.shields.io/badge/license-GPL--2.0-blue.svg)](LICENSE)
-
-## 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("stdex::eval_eq, does not match!");
-  opt = astdx::opt(astdx::eval_eq(50, 40));
-  opt.expect("this time it doesn't.");
-  
-  return 0;
-}
-```
-
-# Licensed under GPL-2
-- 
cgit v1.2.3