Last update before archiving

Author: josantonius

.gitattributes

@@ -1,13 +1,11 @@
+/.github export-ignore
 /tests export-ignore
+/docs export-ignore
 CHANGELOG.md export-ignore
-README.md export-ignore
-README-ES.md export-ignore
 phpcs.xml export-ignore
 phpunit.xml export-ignore
 phpmd.xml export-ignore
-.travis.yml export-ignore
-.editorconfig export-ignore
+phpdoc.xml export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.php_cs.dist export-ignore
-CONDUCT.md export-ignore
+.php-cs-fixer.dist.php export-ignore

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+
+github: [Josantonius]

.gitignore

@@ -1,12 +1,13 @@
-.git*/
 vendor/
-docs/*.pyc
-docs/_build
-build/artifacts/
+coverage/
+.vscode/
+docs/cache/
 composer.phar
 composer.lock
 composer-test.lock
 phpcbf-fixed.diff
-.idea
-.DS_STORE
-.php_cs.cache
+.php_cs.cache
+php-ip.code-workspace
+.repository.md
+.phpunit.result.cache
+coverage.xml

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 1.1.8 - 2022-07-30
+
+The repository was archived.
+
+>After reviewing the code after a few years, I would not recommend the use of the class for a
+>production site, as preference was given to headers easily manipulated by the user to get the IP.
+
+>If the reliability of the header from which the IP will be obtained is not guaranteed,
+>it is better to use $_SERVER['REMOTE_ADDR'] directly or develop a custom solution.
+
 ## 1.1.7 - 2018-01-06
 
 * The tests were fixed.
@@ -43,7 +53,7 @@
 * Unit tests supported by `PHPUnit` were added.
 
 * The repository was synchronized with Travis CI to implement continuous integration.
- 
+
 * Added `Ip/src/bootstrap.php` file
 
 * Added `Ip/tests/bootstrap.php` file.

LICENSE

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 =====================
 
-Copyright (c) `2017 - 2018` `Josantonius, https://josantonius.com <hello@josantonius.com>`
+Copyright (c) 2017-2022, Josantonius
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README-ES.md

@@ -1,11 +1,19 @@
 # PHP Ip library
 
-[![Latest Stable Version](https://poser.pugx.org/josantonius/Ip/v/stable)](https://packagist.org/packages/josantonius/Ip) [![Latest Unstable Version](https://poser.pugx.org/josantonius/Ip/v/unstable)](https://packagist.org/packages/josantonius/Ip) [![License](https://poser.pugx.org/josantonius/Ip/license)](LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9a38ca1727464eb2bbac06a1bb163bce)](https://www.codacy.com/app/Josantonius/PHP-Ip?utm_source=github.com&utm_medium=referral&utm_content=Josantonius/PHP-Ip&utm_campaign=Badge_Grade) [![Total Downloads](https://poser.pugx.org/josantonius/Ip/downloads)](https://packagist.org/packages/josantonius/Ip) [![Travis](https://travis-ci.org/Josantonius/PHP-Ip.svg)](https://travis-ci.org/Josantonius/PHP-Ip) [![PSR2](https://img.shields.io/badge/PSR-2-1abc9c.svg)](http://www.php-fig.org/psr/psr-2/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](http://www.php-fig.org/psr/psr-4/) [![CodeCov](https://codecov.io/gh/Josantonius/PHP-Ip/branch/master/graph/badge.svg)](https://codecov.io/gh/Josantonius/PHP-Ip)
+[![Latest Stable Version](https://poser.pugx.org/josantonius/Ip/v/stable)](https://packagist.org/packages/josantonius/Ip)
+[![License](https://poser.pugx.org/josantonius/Ip/license)](LICENSE)
 
 [English version](README.md)
 
 Biblioteca PHP para obtener la IP del usuario.
 
+>Tras revisar el código después de unos años, no recomendaría el uso de la clase para un sitio en
+>producción, ya que se dio preferencia a cabeceras fácilmente manipulables por el usuario para
+>obtener la IP.
+
+>Si la fiabilidad de la cabecera desde la que se obtendrá la IP no está garantizada, sería
+>mejor utilizar $_SERVER['REMOTE_ADDR'] directamente o desarrollar una solución personalizada.
+
 ---
 
 - [Requisitos](#requisitos)
@@ -14,53 +22,50 @@ Biblioteca PHP para obtener la IP del usuario.
 - [Cómo empezar](#cómo-empezar)
 - [Uso](#uso)
 - [Tests](#tests)
-- [Tareas pendientes](#-tareas-pendientes)
-- [Contribuir](#contribuir)
-- [Repositorio](#repositorio)
+- [Patrocinar](#patrocinar)
 - [Licencia](#licencia)
-- [Copyright](#copyright)
 
 ---
 
 ## Requisitos
 
 Esta clase es soportada por versiones de **PHP 5.6** o superiores y es compatible con versiones de **HHVM 3.0** o superiores.
 
-## Instalación 
+## Instalación
 
 La mejor forma de instalar esta extensión es a través de [Composer](http://getcomposer.org/download/).
 
 Para instalar **PHP Ip library**, simplemente escribe:
 
-    $ composer require Josantonius/Ip
+    composer require Josantonius/Ip
 
 El comando anterior sólo instalará los archivos necesarios, si prefieres **descargar todo el código fuente** puedes utilizar:
 
-    $ composer require Josantonius/Ip --prefer-source
+    composer require Josantonius/Ip --prefer-source
 
 También puedes **clonar el repositorio** completo con Git:
 
-  $ git clone https://github.com/Josantonius/PHP-Ip.git
+  $ git clone <https://github.com/Josantonius/PHP-Ip.git>
 
 O **instalarlo manualmente**:
 
 [Descargar Ip.php](https://raw.githubusercontent.com/Josantonius/PHP-Ip/master/src/Ip.php):
 
-    $ wget https://raw.githubusercontent.com/Josantonius/PHP-Ip/master/src/Ip.php
+    wget https://raw.githubusercontent.com/Josantonius/PHP-Ip/master/src/Ip.php
 
 ## Métodos disponibles
 
 Métodos disponibles en esta biblioteca:
 
-### - Obtener IP del usuario:
+### - Obtener IP del usuario
 
 ```php
 Ip::get();
 ```
 
 **# Return** (string|false) → IP o falso
 
-### - Validar IP:
+### - Validar IP
 
 ```php
 Ip::validate($ip);
@@ -94,86 +99,54 @@ use Josantonius\Ip\Ip;
 
 Ejemplo de uso para esta biblioteca:
 
-### - Obtener IP del usuario:
+### - Obtener IP del usuario
 
 ```php
 Ip::get();
 ```
 
-### - Validar IP:
+### - Validar IP
 
 ```php
 $ip = Ip::get();
 
 Ip::validate($ip);
 ```
 
-## Tests 
+## Tests
 
 Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/) y seguir los siguientes pasos:
 
-    $ git clone https://github.com/Josantonius/PHP-Ip.git
+    git clone https://github.com/Josantonius/PHP-Ip.git
 
-    $ cd PHP-Ip
+    cd PHP-Ip
 
-    $ composer install
+    composer install
 
 Ejecutar pruebas unitarias con [PHPUnit](https://phpunit.de/):
 
-    $ composer phpunit
+    composer phpunit
 
 Ejecutar pruebas de estándares de código [PSR2](http://www.php-fig.org/psr/psr-2/) con [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
 
-    $ composer phpcs
+    composer phpcs
 
 Ejecutar pruebas con [PHP Mess Detector](https://phpmd.org/) para detectar inconsistencias en el estilo de codificación:
 
-    $ composer phpmd
+    composer phpmd
 
 Ejecutar todas las pruebas anteriores:
 
-    $ composer tests
-
-## ☑ Tareas pendientes
-
-- [ ] Añadir nueva funcionalidad.
-- [ ] Mejorar pruebas.
-- [ ] Mejorar documentación.
-- [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver [phpmd.xml](phpmd.xml) y [.php_cs.dist](.php_cs.dist).
-
-## Contribuir
-
-Si deseas colaborar, puedes echar un vistazo a la lista de
-[issues](https://github.com/Josantonius/PHP-Ip/issues) o [tareas pendientes](#-tareas-pendientes).
-
-**Pull requests**
+    composer tests
 
-* [Fork and clone](https://help.github.com/articles/fork-a-repo).
-* Ejecuta el comando `composer install` para instalar dependencias.
-  Esto también instalará las [dependencias de desarrollo](https://getcomposer.org/doc/03-cli.md#install).
-* Ejecuta el comando `composer fix` para estandarizar el código.
-* Ejecuta las [pruebas](#tests).
-* Crea una nueva rama (**branch**), **commit**, **push** y envíame un
-  [pull request](https://help.github.com/articles/using-pull-requests).
+## Patrocinar
 
-**¡Gracias a quienes ya habéis contribuido a este proyecto!**
-
-[<img alt="MASNathan" src="https://avatars0.githubusercontent.com/u/2139464?v=4&s=117 width=117" height="117" width="117">](https://github.com/MASNathan) |
-:---:|
-[MASNathan](https://github.com/MASNathan)|
-
-## Repositorio
-
-La estructura de archivos de este repositorio se creó con [PHP-Skeleton](https://github.com/Josantonius/PHP-Skeleton).
+Si este proyecto te ayuda a reducir el tiempo de desarrollo,
+[puedes patrocinarme](https://github.com/josantonius/lang/es-ES/README.md#patrocinar)
+para apoyar mi trabajo :blush:
 
 ## Licencia
 
-Este proyecto está licenciado bajo **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información.
-
-## Copyright
-
-2017 - 2018 Josantonius, [josantonius.com](https://josantonius.com/)
-
-Si te ha resultado útil, házmelo saber :wink:
+Este repositorio tiene una licencia [MIT License](LICENSE).
 
-Puedes contactarme en [Twitter](https://twitter.com/Josantonius) o a través de mi [correo electrónico](mailto:hello@josantonius.com).
+Copyright © 2017-2022, [Josantonius](https://github.com/josantonius/lang/es-ES/README.md#contacto)