From 4bca88f0f50a653d2ced30afe70b5eb303313cf8 Mon Sep 17 00:00:00 2001 From: Josantonius Date: Sun, 31 Jul 2022 18:36:32 +0200 Subject: [PATCH] docs: improve documentation --- .github/FUNDING.yml | 1 - .github/lang/es-ES/README.md | 7 +------ CHANGELOG.md | 10 +++++++++- README.md | 10 ++-------- 4 files changed, 12 insertions(+), 16 deletions(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index e619056..3b1e273 100755 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1 @@ - github: [Josantonius] \ No newline at end of file diff --git a/.github/lang/es-ES/README.md b/.github/lang/es-ES/README.md index 38ca80a..753b0ea 100755 --- a/.github/lang/es-ES/README.md +++ b/.github/lang/es-ES/README.md @@ -4,7 +4,7 @@ [![License](https://poser.pugx.org/josantonius/hook/license)](LICENSE) [![Total Downloads](https://poser.pugx.org/josantonius/hook/downloads)](https://packagist.org/packages/josantonius/hook) [![CI](https://github.com/josantonius/php-hook/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/josantonius/php-hook/actions/workflows/ci.yml) -[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/master/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook) +[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/main/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook) [![PSR1](https://img.shields.io/badge/PSR-1-f57046.svg)](https://www.php-fig.org/psr/psr-1/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](https://www.php-fig.org/psr/psr-4/) [![PSR12](https://img.shields.io/badge/PSR-12-1abc9c.svg)](https://www.php-fig.org/psr/psr-12/) @@ -13,11 +13,6 @@ Biblioteca para manejo de hooks en PHP. -> La versión 1.x se considera obsoleta y sin soporte. -> En esta versión (2.x) la biblioteca fue completamente reestructurada. -> Se recomienda revisar la documentación de esta versión y hacer los cambios necesarios -> antes de empezar a utilizarla, ya que no es compatible con la versión 1.x. - --- - [Requisitos](#requisitos) diff --git a/CHANGELOG.md b/CHANGELOG.md index 80d0eee..80c1bdc 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,14 @@ # CHANGELOG -## [2.0.0](https://github.com/josantonius/php-hook/releases/tag/2.0.0) (2022-07-30) +## [v2.0.1](https://github.com/josantonius/php-hook/releases/tag/v2.0.1) (2022-07-31) + +* Removed the warning about version 1.x in the `README.md` files. + +* Fixed blank line at the beginning of the file in `FUNDING.yml`. + +* Fixed CodeCov link in the `README.md` files. + +## [v2.0.0](https://github.com/josantonius/php-hook/releases/tag/v2.0.0) (2022-07-30) > Version 1.x is considered as deprecated and unsupported. > In this version (2.x) the library was completely restructured. diff --git a/README.md b/README.md index c13fa55..f2ed992 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![License](https://poser.pugx.org/josantonius/hook/license)](LICENSE) [![Total Downloads](https://poser.pugx.org/josantonius/hook/downloads)](https://packagist.org/packages/josantonius/hook) [![CI](https://github.com/josantonius/php-hook/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/josantonius/php-hook/actions/workflows/ci.yml) -[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/master/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook) +[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/main/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook) [![PSR1](https://img.shields.io/badge/PSR-1-f57046.svg)](https://www.php-fig.org/psr/psr-1/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](https://www.php-fig.org/psr/psr-4/) [![PSR12](https://img.shields.io/badge/PSR-12-1abc9c.svg)](https://www.php-fig.org/psr/psr-12/) @@ -13,11 +13,6 @@ Library for handling hooks in PHP. -> Version 1.x is considered as deprecated and unsupported. -> In this version (2.x) the library was completely restructured. -> It is recommended to review the documentation for this version and make the necessary changes -> before starting to use it, as it not be compatible with version 1.x. - --- - [Requirements](#requirements) @@ -391,8 +386,7 @@ Run unit tests with [PHPUnit](https://phpunit.de/): composer phpunit ``` -Run [PSR12](http://www.php-fig.org/psr/psr-12/) code standard tests with -[PHPCS](https://github.com/squizlabs/PHP_CodeSniffer): +Run code standard tests with [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer): ```console composer phpcs