docs: improve documentation

josantonius · josantonius · commit afb7319bf858 · 2022-08-11T15:28:31.000+02:00
diff --git a/.github/lang/es-ES/README.md b/.github/lang/es-ES/README.md
@@ -17,8 +17,9 @@ Biblioteca de PHP para obtener mensajes y definiciones de códigos de estado HTT
 
 - [Requisitos](#requisitos)
 - [Instalación](#instalación)
-- [Métodos disponibles](#métodos-disponibles)
-- [Cómo empezar](#cómo-empezar)
+- [Available Classes](#available-classes)
+  - [Clase HttpStatusCode](#clase-httpstatuscode)
+- [Excepciones utilizadas](#excepciones-utilizadas)
 - [Uso](#uso)
 - [Listado en formato JSON](#listado-en-formato-json)
 - [Tests](#tests)
@@ -57,69 +58,69 @@ También puedes **clonar el repositorio** completo con Git:
 git clone https://github.com/josantonius/http-status-code.git
 ```
 
-## Métodos disponibles
+## Clases disponibles
 
-Métodos disponibles en esta biblioteca:
-
-### Crear una nueva instancia que defina el idioma
+### Clase HttpStatusCode
 
 ```php
-$httpStatusCode = new HttpStatusCode(string $language = 'en');
+use Josantonius\HttpStatusCode\HttpStatusCode;
 ```
 
-**@param** `$language` El idioma en el que se recuperarán los datos. Idiomas disponibles:
-'en' (inglés) y
-'es' (español).
+Crear una nueva instancia que defina el idioma:
 
-**@throws** `UnsupportedLanguageException` si el idioma no está soportado.
+```php
+/**
+ * @param string $language El idioma en el que se recuperarán los datos.
+ *
+ *                         Idiomas disponibles: en (inglés)
+ *                                              es (español)
+ * 
+ * @throws UnsupportedLanguageException if language is not supported.
+ */
+$httpStatusCode = new HttpStatusCode(string $language = 'en');
+```
 
-## Obtiene el mensaje de un código de estado HTTP
+Obtiene el mensaje de un código de estado HTTP:
 
 ```php
 $httpStatusCode->getMessage(int $code): string|null
 ```
 
-## Obtiene los mensajes de todos los códigos de estado HTTP
+Obtiene los mensajes de todos los códigos de estado HTTP:
 
 ```php
 $httpStatusCode->getMessages(): array
 ```
 
-## Obtiene la definición de un código de estado HTTP
+Obtiene la definición de un código de estado HTTP:
 
 ```php
 $httpStatusCode->getDefinition(int $code): string|null
 ```
 
-## Obtiene las definiciones de todos los códigos de estado HTTP
+Obtiene las definiciones de todos los códigos de estado HTTP:
 
 ```php
 $httpStatusCode->getDefinitions(): array
 ```
 
-## Obtiene mensajes y definiciones de todos los códigos de estado HTTP
+Obtiene mensajes y definiciones de todos los códigos de estado HTTP:
 
 ```php
 $httpStatusCode->getAll(): array
 ```
 
-## Cómo empezar
-
-Para utilizar esta biblioteca con **Composer**:
+## Excepciones utilizadas
 
 ```php
-require __DIR__ . '/vendor/autoload.php';
-```
-
-```php
-use Josantonius\HttpStatusCode\HttpStatusCode;
+use Josantonius\HttpStatusCode\UnsupportedLanguageException;
 ```
 
 ## Uso
 
 Ejemplo de uso para esta biblioteca:
 
-### - Crear una nueva instancia que defina el idioma
+### Crear una nueva instancia que defina el idioma
 
 ```php
 $httpStatusCode = new HttpStatusCode();     // Obtiene los mensajes en inglés.
@@ -129,25 +130,33 @@ $httpStatusCode = new HttpStatusCode();     // Obtiene los mensajes en inglés.
 $httpStatusCode = new HttpStatusCode('es'); // Obtiene los mensajes en español.
 ```
 
-## - Obtiene el mensaje de un código de estado HTTP
+### Obtiene el mensaje de un código de estado HTTP
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getMessage(404);
 ```
 
-Returns:
+Devuelve:
 
 ```php
 'No encontrado'
 ```
 
-## - Obtiene los mensajes de todos los códigos de estado HTTP
+### Obtiene los mensajes de todos los códigos de estado HTTP
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getMessages();
 ```
 
-Returns:
+Devuelve:
 
 ```php
 [
@@ -159,25 +168,33 @@ Returns:
 ]
 ```
 
-## - Obtiene la definición de un código de estado HTTP
+### Obtiene la definición de un código de estado HTTP
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getDefinition(404);
 ```
 
-Returns:
+Devuelve:
 
 ```php
 'Recurso no encontrado. Se utiliza cuando (...)'
 ```
 
-## - Obtiene las definiciones de todos los códigos de estado HTTP
+### Obtiene las definiciones de todos los códigos de estado HTTP
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getDefinitions();
 ```
 
-Returns:
+Devuelve:
 
 ```php
 [
@@ -189,9 +206,13 @@ Returns:
 ]
 ```
 
-## - Obtiene mensajes y definiciones de todos los códigos de estado HTTP
+### Obtiene mensajes y definiciones de todos los códigos de estado HTTP
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getAll();
 ```
 
diff --git a/README.md b/README.md
@@ -17,8 +17,9 @@ PHP library to get HTTP status code messages and definitions.
 
 - [Requirements](#requirements)
 - [Installation](#installation)
-- [Available Methods](#available-methods)
-- [Quick Start](#quick-start)
+- [Available Classes](#available-classes)
+  - [HttpStatusCode Class](#httpstatuscode-class)
+- [Exceptions Used](#exceptions-used)
 - [Usage](#usage)
 - [List in JSON format](#list-in-json-format)
 - [Tests](#tests)
@@ -57,81 +58,87 @@ You can also **clone the complete repository** with Git:
 git clone https://github.com/josantonius/http-status-code.git
 ```
 
-## Available Methods
+## Available Classes
 
-Available methods in this library:
-
-### Create a new instance defining the language
+### HttpStatusCode Class
 
 ```php
-$httpStatusCode = new HttpStatusCode(string $language = 'en');
+use Josantonius\HttpStatusCode\HttpStatusCode;
 ```
 
-**@param** `$language` The language in which the data will be retrieved. Available languages:
-'en' (English) and
-'es' (Spanish).
+Create a new instance defining the language:
 
-**@throws** `UnsupportedLanguageException` if language is not supported.
+```php
+/**
+ * @param string $language The language in which the data will be retrieved.
+ *
+ *                         Available languages: en (English)
+ *                                              es (Spanish)
+ * 
+ * @throws UnsupportedLanguageException if language is not supported.
+ */
+$httpStatusCode = new HttpStatusCode(string $language = 'en');
+```
 
-## Gets message of an HTTP status code
+Gets message of an HTTP status code:
 
 ```php
 $httpStatusCode->getMessage(int $code): string|null
 ```
 
-## Gets the messages of all HTTP status codes
+Gets the messages of all HTTP status codes:
 
 ```php
 $httpStatusCode->getMessages(): array
 ```
 
-## Gets definition of an HTTP status code
+Gets definition of an HTTP status code:
 
 ```php
 $httpStatusCode->getDefinition(int $code): string|null
 ```
 
-## Gets the definitions of all HTTP status codes
+Gets the definitions of all HTTP status codes:
 
 ```php
 $httpStatusCode->getDefinitions(): array
 ```
 
-## Gets messages and definitions of all HTTP status codes
+Gets messages and definitions of all HTTP status codes:
 
 ```php
 $httpStatusCode->getAll(): array
 ```
 
-## Quick Start
-
-To use this library with **Composer**:
+## Exceptions Used
 
 ```php
-require __DIR__ . '/vendor/autoload.php';
-```
-
-```php
-use Josantonius\HttpStatusCode\HttpStatusCode;
+use Josantonius\HttpStatusCode\UnsupportedLanguageException;
 ```
 
 ## Usage
 
 Example of use for this library:
 
-### - Create a new instance defining the language
+### Create a new instance defining the language
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
 $httpStatusCode = new HttpStatusCode();     // Gets the messages in English.
 ```
 
 ```php
 $httpStatusCode = new HttpStatusCode('es'); // Gets the messages in Spanish.
 ```
 
-## - Gets message of an HTTP status code
+### Gets message of an HTTP status code
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getMessage(404);
 ```
 
@@ -141,9 +148,13 @@ Returns:
 'Not Found'
 ```
 
-## - Gets the messages of all HTTP status codes
+### Gets the messages of all HTTP status codes
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getMessages();
 ```
 
@@ -159,9 +170,13 @@ Returns:
 ]
 ```
 
-## - Gets definition of an HTTP status code
+### Gets definition of an HTTP status code
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getDefinition(404);
 ```
 
@@ -171,9 +186,13 @@ Returns:
 'The requested resource could not be found but (...)'
 ```
 
-## - Gets the definitions of all HTTP status codes
+### Gets the definitions of all HTTP status codes
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getDefinitions();
 ```
 
@@ -189,9 +208,13 @@ Returns:
 ]
 ```
 
-## - Gets messages and definitions of all HTTP status codes
+### Gets messages and definitions of all HTTP status codes
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
+$httpStatusCode = new HttpStatusCode();
+
 $httpStatusCode->getAll();
 ```
 
