docs: improve documentation

josantonius · josantonius · commit 67a29c08d137 · 2022-08-11T17:04:05.000+02:00
diff --git a/.github/lang/es-ES/README.md b/.github/lang/es-ES/README.md
@@ -17,8 +17,9 @@ Librería PHP para obtener el nombre del lenguaje a partir del código.
 
 - [Requisitos](#requisitos)
 - [Instalación](#instalación)
-- [Métodos disponibles](#métodos-disponibles)
-- [Cómo empezar](#cómo-empezar)
+- [Clases disponibles](#clases-disponibles)
+  - [Clase LanguageCode](#clase-languagecode)
+  - [Clase LanguageCodeCollection](#clase-languagecodecollection)
 - [Uso](#uso)
 - [Listado en formato JSON](#listado-en-formato-json)
 - [Tests](#tests)
@@ -44,7 +45,8 @@ Para instalar **PHP LanguageCode library**, simplemente escribe:
 composer require josantonius/language-code
 ```
 
-El comando anterior sólo instalará los archivos necesarios, si prefieres **descargar todo el código fuente** puedes utilizar:
+El comando anterior sólo instalará los archivos necesarios,
+si prefieres **descargar todo el código fuente** puedes utilizar:
 
 ```console
 composer require josantonius/language-code --prefer-source
@@ -56,64 +58,80 @@ También puedes **clonar el repositorio** completo con Git:
 clone https://github.com/josantonius/php-language-code.git
 ```
 
-## Métodos disponibles
+## Clases disponibles
 
-Métodos disponibles en esta biblioteca:
+### Clase LanguageCode
 
-### Obtener array con todos los códigos de idioma
+```php
+use Josantonius\LanguageCode\LanguageCode;
+```
+
+Crear objeto:
+
+```php
+$languageCode = new LanguageCode();
+```
+
+Obtener array con todos los códigos de idioma:
 
 ```php
 $languageCode->all(): array
 ```
 
-### Obtener código de idioma desde el nombre del idioma
+Obtener código de idioma desde el nombre del idioma:
 
 ```php
 $languageCode->getCode(string $languageName): string|null
 ```
 
-### Obtener el nombre del idioma desde código de idioma
+Obtener el nombre del idioma desde código de idioma:
 
 ```php
 $languageCode->getName(string $languageCode): string|null
 ```
 
-## Cómo empezar
+### Clase LanguageCodeCollection
 
-Para utilizar esta biblioteca, simplemente:
+```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+```
 
-### Utilizando objetos
+Obtener array con todos los códigos de idioma:
 
 ```php
-use Josantonius\LanguageCode\LanguageCode;
-
-$mimeType = new LanguageCode();
+LanguageCodeCollection::all(): array
 ```
 
-### Utilizando colección estática
+Obtener código de idioma desde el nombre del idioma:
 
-Alternativamente puedes utilizar la colección para acceder a los métodos estáticamente:
+```php
+LanguageCodeCollection::getCode(string $languageName): string|null
+```
+
+Obtener el nombre del idioma desde código de idioma:
 
 ```php
-use Josantonius\LanguageCode\LanguageCodeCollection;
+LanguageCodeCollection::getName(string $languageCode): string|null
 ```
 
 ## Uso
 
 Ejemplo de uso para esta biblioteca:
 
-### - Obtener array con todos los códigos de idioma
-
-[Utilizando objetos](#utilizando-objetos):
+### Obtener array con todos los códigos de idioma
 
 ```php
+use Josantonius\LanguageCode\LanguageCode;
+
+$languageCode = new LanguageCode();
+
 $languageCode->all();
 ```
 
-[Utilizando la colección estática](#utilizando-colección-estática):
-
 ```php
-MimeTypeCollection::all();
+use Josantonius\LanguageCode\LanguageCodeCollection;
+
+LanguageCodeCollection::all();
 ```
 
 Resultado:
@@ -134,31 +152,35 @@ Resultado:
 ]
 ```
 
-### - Obtener código de idioma desde el nombre del idioma
-
-[Utilizando objetos](#utilizando-objetos):
+### Obtener código de idioma desde el nombre del idioma
 
 ```php
+use Josantonius\LanguageCode\LanguageCode;
+
+$languageCode = new LanguageCode();
+
 $languageCode->getCode('Spanish'); // es
 ```
 
-[Utilizando la colección estática](#utilizando-colección-estática):
-
 ```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+
 LanguageCodeCollection::getCode('Turkish'); // tr
 ```
 
-### - Obtener el nombre del idioma desde código de idioma
-
-[Utilizando objetos](#utilizando-objetos):
+### Obtener el nombre del idioma desde código de idioma
 
 ```php
+use Josantonius\LanguageCode\LanguageCode;
+
+$languageCode = new LanguageCode();
+
 $languageCode->getName('eo'); // Esperanto
 ```
 
-[Utilizando la colección estática](#utilizando-colección-estática):
-
 ```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+
 LanguageCodeCollection::getName('de'); // German
 ```
 
@@ -217,14 +239,14 @@ composer tests
 ## Registro de Cambios
 
 Los cambios detallados de cada versión se documentan en las
-[notas de la misma](https://github.com/josantonius/XXXX/releases).
+[notas de la misma](https://github.com/josantonius/php-language-code/releases).
 
 ## Contribuir
 
 Por favor, asegúrate de leer la [Guía de contribución](CONTRIBUTING.md) antes de hacer un
 _pull request_, comenzar una discusión o reportar un _issue_.
 
-¡Gracias por [colaborar](https://github.com/josantonius/XXXX/graphs/contributors)! :heart:
+¡Gracias por [colaborar](https://github.com/josantonius/php-language-code/graphs/contributors)! :heart:
 
 ## Patrocinar
 
@@ -236,4 +258,4 @@ para apoyar mi trabajo :blush:
 
 Este repositorio tiene una licencia [MIT License](LICENSE).
 
-Copyright © XXXX, [Josantonius](https://github.com/josantonius/lang/es-ES/README.md#contacto)
+Copyright © 2017-actualidad, [Josantonius](https://github.com/josantonius/lang/es-ES/README.md#contacto)
diff --git a/README.md b/README.md
@@ -17,8 +17,9 @@ PHP library to get language name from code.
 
 - [Requirements](#requirements)
 - [Installation](#installation)
-- [Available Methods](#available-methods)
-- [Quick Start](#quick-start)
+- [Available Classes](#available-classes)
+  - [LanguageCode Class](#languagecode-class)
+  - [LanguageCodeCollection Class](#languagecodecollection-class)
 - [Usage](#usage)
 - [List in JSON format](#list-in-json-format)
 - [Tests](#tests)
@@ -32,7 +33,7 @@ PHP library to get language name from code.
 
 ## Requirements
 
-This library is supported by **PHP versions 5.6** or higher and is compatible with **HHVM versions 3.0** or higher.
+This library is compatible with the PHP versions: 8.0 | 8.1.
 
 ## Installation
 
@@ -44,7 +45,8 @@ To install **PHP LanguageCode library**, simply:
 composer require josantonius/language-code
 ```
 
-The previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:
+The previous command will only install the necessary files,
+if you prefer to **download the entire source code** you can use:
 
 ```console
 composer require josantonius/language-code --prefer-source
@@ -56,63 +58,79 @@ You can also **clone the complete repository** with Git:
 clone https://github.com/josantonius/php-language-code.git
 ```
 
-## Available Methods
+## Available Classes
 
-Available methods in this library:
+### LanguageCode Class
 
-### Get all language codes as array
+```php
+use Josantonius\LanguageCode\LanguageCode;
+```
+
+Create object:
+
+```php
+$languageCode = new LanguageCode();
+```
+
+Get all language codes as array:
 
 ```php
 $languageCode->all(): array
 ```
 
-### Get language code from language name
+Get language code from language name:
 
 ```php
 $languageCode->getCode(string $languageName): string|null
 ```
 
-### Get language name from language code
+Get language name from language code:
 
 ```php
 $languageCode->getName(string $languageCode): string|null
 ```
 
-## Quick Start
+### LanguageCodeCollection Class
 
-To use this library:
+```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+```
 
-### Using Objects
+Get all language codes as array:
 
 ```php
-use Josantonius\LanguageCode\LanguageCode;
-
-$languageCode = new LanguageCode();
+LanguageCodeCollection::all(): array
 ```
 
-### Using Static Collection
+Get language code from language name:
+
+```php
+LanguageCodeCollection::getCode(string $languageName): string|null
+```
 
-Alternatively you can use the collection to access the methods statically:
+Get language name from language code:
 
 ```php
-use Josantonius\LanguageCode\LanguageCodeCollection;
+LanguageCodeCollection::getName(string $languageCode): string|null
 ```
 
 ## Usage
 
 Example of use for this library:
 
-### - Get all language codes as array
-
-[Using objects](#using-objects):
+### Get all language codes as array
 
 ```php
+use Josantonius\LanguageCode\LanguageCode;
+
+$languageCode = new LanguageCode();
+
 $languageCode->all();
 ```
 
-[Using the static collection](#using-static-collection):
-
 ```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+
 LanguageCodeCollection::all();
 ```
 
@@ -134,31 +152,35 @@ Result:
 ]
 ```
 
-### - Get language code from language name
-
-[Using objects](#using-objects):
+### Get language code from language name
 
 ```php
+use Josantonius\LanguageCode\LanguageCode;
+
+$languageCode = new LanguageCode();
+
 $languageCode->getCode('Spanish'); // es
 ```
 
-[Using the static collection](#using-static-collection):
-
 ```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+
 LanguageCodeCollection::getCode('Turkish'); // tr
 ```
 
-### - Get language name from language code
-
-[Using objects](#using-objects):
+### Get language name from language code
 
 ```php
+use Josantonius\LanguageCode\LanguageCode;
+
+$languageCode = new LanguageCode();
+
 $languageCode->getName('eo'); // Esperanto
 ```
 
-[Using the static collection](#using-static-collection):
-
 ```php
+use Josantonius\LanguageCode\LanguageCodeCollection;
+
 LanguageCodeCollection::getName('de'); // German
 ```
 
