Merge remote-tracking branch 'origin/main' into main

Author: julkwel

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Julien Rajerison 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,35 @@
 # php-string-tools
-String tools for php
+
+String tools for php, special chars cleaner and string comparison ... [WIP]
+
+## Installation :
+`$ composer require julkwel/stringtools`
+
+## Usage :
+
+**- String special chars cleaner**
+
+```
+$textToClean = "ÉÉÊÊÎÎÎî ëŷ we are with spécïal charactêrs and w'ill clean";
+\Julkwel\StringTools\StrCleaner::cleanString($textToClean)
+
+Output: "eeeeiiii ey we are with special characters and will clean"
+```
+
+**- String Comparison :**
+
+1. Simple use : 
+```
+echo \Julkwel\StringTools\StrCompare::isStringIsEquals("test", "test");
+
+Output: true
+```
+
+2. Special char removal use : 
+```
+echo \Julkwel\StringTools\StrCompare::isStringIsEquals("têst", "test");
+
+Output: true
+```
+
+Feel free to reach out to me and say hi !.