Add ReadMe.md

ReadMe.md

@@ -0,0 +1,36 @@
+<p align="center"><img src=".github/assets/t.regx.png" alt="T-Regx"></p>
+
+<p align="center">
+    <a href="https://github.com/t-regx/functions/actions/">
+        <img src="https://github.com/t-regx/functions/workflows/build/badge.svg" alt="Build status"/>
+    </a>
+</p>
+
+# Regex | Set of function helpers
+
+![PHP Version](https://img.shields.io/badge/PHP-8.0-blue.svg)
+![PHP Version](https://img.shields.io/badge/PHP-8.1-blue.svg)
+![PHP Version](https://img.shields.io/badge/PHP-8.2-blue.svg)
+![PHP Version](https://img.shields.io/badge/PHP-8.3-blue.svg)
+![PHP Version](https://img.shields.io/badge/PHP-8.4-blue.svg)
+
+A set of helper functions with modern interface for built-in PHP `preg_` functions. Revamped approach
+of [T-Regx](https://github.com/T-Regx/T-Regx) library.
+
+[Buy me a coffee!](https://www.buymeacoffee.com/danielwilkowski)
+
+## Examples
+
+```php
+re_test('[a-z]+', 'word');
+```
+```
+bool (true)
+```
+
+```php
+re_test('[a-z]+', 'WORD', modifiers:'i');
+```
+```
+bool (true)
+```