Skip to content

Commit 4bca88f

Browse files
committed
docs: improve documentation
1 parent 858fe63 commit 4bca88f

File tree

4 files changed

+12
-16
lines changed

4 files changed

+12
-16
lines changed

.github/FUNDING.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
21
github: [Josantonius]

.github/lang/es-ES/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![License](https://poser.pugx.org/josantonius/hook/license)](LICENSE)
55
[![Total Downloads](https://poser.pugx.org/josantonius/hook/downloads)](https://packagist.org/packages/josantonius/hook)
66
[![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)
7-
[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/master/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook)
7+
[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/main/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook)
88
[![PSR1](https://img.shields.io/badge/PSR-1-f57046.svg)](https://www.php-fig.org/psr/psr-1/)
99
[![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](https://www.php-fig.org/psr/psr-4/)
1010
[![PSR12](https://img.shields.io/badge/PSR-12-1abc9c.svg)](https://www.php-fig.org/psr/psr-12/)
@@ -13,11 +13,6 @@
1313

1414
Biblioteca para manejo de hooks en PHP.
1515

16-
> La versión 1.x se considera obsoleta y sin soporte.
17-
> En esta versión (2.x) la biblioteca fue completamente reestructurada.
18-
> Se recomienda revisar la documentación de esta versión y hacer los cambios necesarios
19-
> antes de empezar a utilizarla, ya que no es compatible con la versión 1.x.
20-
2116
---
2217

2318
- [Requisitos](#requisitos)

CHANGELOG.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# CHANGELOG
22

3-
## [2.0.0](https://github.com/josantonius/php-hook/releases/tag/2.0.0) (2022-07-30)
3+
## [v2.0.1](https://github.com/josantonius/php-hook/releases/tag/v2.0.1) (2022-07-31)
4+
5+
* Removed the warning about version 1.x in the `README.md` files.
6+
7+
* Fixed blank line at the beginning of the file in `FUNDING.yml`.
8+
9+
* Fixed CodeCov link in the `README.md` files.
10+
11+
## [v2.0.0](https://github.com/josantonius/php-hook/releases/tag/v2.0.0) (2022-07-30)
412

513
> Version 1.x is considered as deprecated and unsupported.
614
> In this version (2.x) the library was completely restructured.

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![License](https://poser.pugx.org/josantonius/hook/license)](LICENSE)
55
[![Total Downloads](https://poser.pugx.org/josantonius/hook/downloads)](https://packagist.org/packages/josantonius/hook)
66
[![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)
7-
[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/master/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook)
7+
[![CodeCov](https://codecov.io/gh/josantonius/php-hook/branch/main/graph/badge.svg)](https://codecov.io/gh/josantonius/php-hook)
88
[![PSR1](https://img.shields.io/badge/PSR-1-f57046.svg)](https://www.php-fig.org/psr/psr-1/)
99
[![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](https://www.php-fig.org/psr/psr-4/)
1010
[![PSR12](https://img.shields.io/badge/PSR-12-1abc9c.svg)](https://www.php-fig.org/psr/psr-12/)
@@ -13,11 +13,6 @@
1313

1414
Library for handling hooks in PHP.
1515

16-
> Version 1.x is considered as deprecated and unsupported.
17-
> In this version (2.x) the library was completely restructured.
18-
> It is recommended to review the documentation for this version and make the necessary changes
19-
> before starting to use it, as it not be compatible with version 1.x.
20-
2116
---
2217

2318
- [Requirements](#requirements)
@@ -391,8 +386,7 @@ Run unit tests with [PHPUnit](https://phpunit.de/):
391386
composer phpunit
392387
```
393388

394-
Run [PSR12](http://www.php-fig.org/psr/psr-12/) code standard tests with
395-
[PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
389+
Run code standard tests with [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
396390

397391
```console
398392
composer phpcs

0 commit comments

Comments
 (0)