Skip to content

Commit

Permalink
docs: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
josantonius committed Jul 31, 2022
1 parent 858fe63 commit 4bca88f
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 16 deletions.
1 change: 0 additions & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@

github: [Josantonius]
7 changes: 1 addition & 6 deletions .github/lang/es-ES/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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)
Expand Down
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 4bca88f

Please sign in to comment.