From 14b188a31e0454de53d1f9325a552261c41c1786 Mon Sep 17 00:00:00 2001
From: Wilmer Arambula <terabytesoftw@gmail.com>
Date: Sun, 25 Feb 2024 10:39:57 -0300
Subject: [PATCH] Add docs.

---
 README.md                   | 68 +++++++++++++++++++++++++++++++++++--
 composer.json               | 10 +++---
 src/Password.php            |  2 +-
 src/TimeZone.php            |  2 +-
 src/WordFormatter.php       |  2 +-
 tests/PasswordTest.php      |  4 +--
 tests/TimeZoneTest.php      |  8 ++---
 tests/WordFormatterTest.php |  4 +--
 8 files changed, 82 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 81ce0b9..ec650be 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
     <a href="https://github.com/php-forge/helpers" target="_blank">
         <img src="https://avatars.githubusercontent.com/u/103309199?s%25253D400%252526u%25253Dca3561c692f53ed7eb290d3bb226a2828741606f%252526v%25253D4" height="100px">
     </a>
-    <h1 align="center">Collection of Helpers for PHP.</h1>
+    <h1 align="center">Collection of Helper for PHP.</h1>
     <br>
 </p>
 
@@ -45,7 +45,71 @@ or add
 
 ## Usage
 
-[Check the documentation docs](/docs/README.md) to learn about usage.
+The repository contains a collection of utility functions designed to simplify common programming tasks in PHP.
+
+Whether you're working on web development, data processing, or other projects, these helper functions can save you time
+and effort.
+
+## Converts a camelCase formatted string to snake_case
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use PHPForge\Helper\WordFormatter;
+
+$word = WordFormatter::camelCaseToSnakeCase('date_birth');
+```
+
+## Convert a snake_case formatted string to camelCase
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use PHPForge\Helper\WordFormatter;
+
+$word = WordFormatter::snakeCaseToCamelCase('date_birth');
+```
+
+##  Converts a string to words with capitalized first letters
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use PHPForge\Helper\WordFormatter;
+
+$word = WordFormatter::capitalizeToWords('Date Birth');
+```
+
+## Generate ramdon pasword
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use PHPForge\Helper\Password;
+
+$password = Password::generate(8);
+```
+
+
+## Get all timezones
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use PHPForge\Helper\Timezone;
+
+$timezones = Timezone::getAll();
+```
 
 ## Testing
 
diff --git a/composer.json b/composer.json
index 62f3f79..64e41ac 100644
--- a/composer.json
+++ b/composer.json
@@ -1,10 +1,10 @@
 {
-    "name": "php-forge/helpers",
+    "name": "php-forge/helper",
     "type": "library",
-    "description": "Collection of Helpers for PHP.",
+    "description": "Collection of Helper for PHP.",
     "keywords": [
         "php-forge",
-        "helpers"
+        "helper"
     ],
     "license": "mit",
     "require": {
@@ -19,12 +19,12 @@
     },
     "autoload": {
         "psr-4": {
-            "PHPForge\\Helpers\\": "src"
+            "PHPForge\\Helper\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "PHPForge\\Helpers\\Tests\\": "tests"
+            "PHPForge\\Helper\\Tests\\": "tests"
         }
     },
     "extra": {
diff --git a/src/Password.php b/src/Password.php
index 6ad1b89..c9b8732 100644
--- a/src/Password.php
+++ b/src/Password.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Helpers;
+namespace PHPForge\Helper;
 
 use function array_map;
 use function implode;
diff --git a/src/TimeZone.php b/src/TimeZone.php
index abd55dc..9b3d7d3 100644
--- a/src/TimeZone.php
+++ b/src/TimeZone.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Helpers;
+namespace PHPForge\Helper;
 
 use DateTime;
 use DateTimeZone;
diff --git a/src/WordFormatter.php b/src/WordFormatter.php
index 8596d71..b7ca58b 100644
--- a/src/WordFormatter.php
+++ b/src/WordFormatter.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Helpers;
+namespace PHPForge\Helper;
 
 use function explode;
 use function implode;
diff --git a/tests/PasswordTest.php b/tests/PasswordTest.php
index 34b2765..e07abb9 100644
--- a/tests/PasswordTest.php
+++ b/tests/PasswordTest.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Helpers\Tests;
+namespace PHPForge\Helper\Tests;
 
-use PHPForge\Helpers\Password;
+use PHPForge\Helper\Password;
 use PHPUnit\Framework\TestCase;
 
 final class PasswordTest extends TestCase
diff --git a/tests/TimeZoneTest.php b/tests/TimeZoneTest.php
index 32cb042..d88f1a5 100644
--- a/tests/TimeZoneTest.php
+++ b/tests/TimeZoneTest.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Helpers\Tests;
+namespace PHPForge\Helper\Tests;
 
-use PHPForge\Helpers\TimeZone;
+use PHPForge\Helper\TimeZone;
 use PHPUnit\Framework\TestCase;
 
 final class TimeZoneTest extends TestCase
@@ -41,12 +41,12 @@ public function testGetAllReturnsOrderedTimeZones()
         $prevOffset = null;
 
         foreach ($timeZones as $timeZone) {
-            // Verifica que el offset sea mayor o igual al offset anterior
+            // verify that the offset is greater than or equal to the previous offset
             if ($prevOffset !== null) {
                 $this->assertGreaterThanOrEqual($prevOffset, $timeZone['offset']);
             }
 
-            // Verifica que el array tenga las claves correctas
+            // verify that the array contains the expected keys
             $this->assertArrayHasKey('timezone', $timeZone);
             $this->assertArrayHasKey('name', $timeZone);
             $this->assertArrayHasKey('offset', $timeZone);
diff --git a/tests/WordFormatterTest.php b/tests/WordFormatterTest.php
index 2b7c98e..fdf4551 100644
--- a/tests/WordFormatterTest.php
+++ b/tests/WordFormatterTest.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Helpers\Tests;
+namespace PHPForge\Helper\Tests;
 
-use PHPForge\Helpers\WordFormatter;
+use PHPForge\Helper\WordFormatter;
 use PHPUnit\Framework\TestCase;
 
 final class WordFormatterTest extends TestCase