Readme update (#95)

* update : project name updated.

* update : project description updated.

* log : changes logged.

* fix : bad character fixed.

* add : `ipv6` added to `keywords`.

* update : name updated.

Author: sadrasabouri

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- `README.md` updated
 ## [0.7] - 2025-12-09
 ### Added
 - `--backoff-factor` argument

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 <img src="https://github.com/openscilab/ipspot/raw/main/otherfiles/logo.png" width="350">
-<h1>IPSpot: A Python Tool to Fetch the System's IP Address</h1>
+<h1>IPSpot: Retrieve IPv4/IPv6 Addresses with Geolocation Data</h1>
 <br/>
 <a href="https://codecov.io/gh/openscilab/ipspot"><img src="https://codecov.io/gh/openscilab/ipspot/graph/badge.svg?token=XCFKASULS8"></a>
 <a href="https://badge.fury.io/py/ipspot"><img src="https://badge.fury.io/py/ipspot.svg" alt="PyPI version"></a>
@@ -12,7 +12,7 @@
 ## Overview	
 
 <p align="justify">					
-<b>IPSpot</b> is a Python library for retrieving the current system's IP address and location information. It currently supports public and private <b>IPv4</b> detection using multiple API providers with a fallback mechanism for reliability. Designed with simplicity and modularity in mind, <b>IPSpot</b> offers quick IP and geolocation lookups directly from your machine.
+<b>IPSpot</b> is a Python library for retrieving the current system's IP data and detailed location information such as region, longitude, and latitude. It supports both public and private <b>IPv4</b> and <b>IPv6</b> detection through multiple API providers, using a fallback mechanism for improved reliability. It has a simple and modular design, making it easy to perform fast IP, geolocation, provider, and regional lookups directly from your machine.
 </p>
 
 <table>
@@ -138,9 +138,9 @@ __     __     ___      _____
 
 
 
-IPSpot is a Python library for retrieving the current system's IP address and location information.
-It currently supports public and private IPv4 detection using multiple API providers with a fallback mechanism for reliability.
-Designed with simplicity and modularity in mind, IPSpot offers quick IP and geolocation lookups directly from your machine.
+IPSpot is a Python library for retrieving the current system’s IP data and detailed location information such as region, longitude, and latitude.
+It supports both public and private IPv4 and IPv6 detection through multiple API providers, using a fallback mechanism for improved reliability.
+It has a simple and modular design, making it easy to perform fast IP, geolocation, provider, and regional lookups directly from your machine.
 
 Repo : https://github.com/openscilab/ipspot
 

ipspot/params.py

@@ -5,9 +5,9 @@
 IPSPOT_VERSION = "0.7"
 
 IPSPOT_OVERVIEW = '''
-IPSpot is a Python library for retrieving the current system's IP address and location information.
-It currently supports public and private IPv4 detection using multiple API providers with a fallback mechanism for reliability.
-Designed with simplicity and modularity in mind, IPSpot offers quick IP and geolocation lookups directly from your machine.
+IPSpot is a Python library for retrieving the current system's IP data and detailed location information such as region, longitude, and latitude.
+It supports both public and private IPv4 and IPv6 detection through multiple API providers, using a fallback mechanism for improved reliability.
+It has a simple and modular design, making it easy to perform fast IP, geolocation, provider, and regional lookups directly from your machine.
 '''
 
 IPSPOT_REPO = "https://github.com/openscilab/ipspot"

setup.py

@@ -24,24 +24,24 @@ def read_description() -> str:
             description += c.read()
         return description
     except Exception:
-        return '''IPSpot is a Python library for retrieving the current system's IP address and location information.
-        It currently supports public and local IPv4 detection using multiple API providers with a fallback mechanism for reliability.
-        Designed with simplicity and modularity in mind, IPSpot offers quick IP and geolocation lookups directly from your machine.'''
+        return '''IPSpot is a Python library for retrieving the current system's IP data and detailed location information such as region, longitude, and latitude.
+        It supports both public and private IPv4 and IPv6 detection through multiple API providers, using a fallback mechanism for improved reliability.
+        It has a simple and modular design, making it easy to perform fast IP, geolocation, provider, and regional lookups directly from your machine.'''
 
 
 setup(
     name='ipspot',
     packages=['ipspot'],
     version='0.7',
-    description='IPSpot: A Python Tool to Fetch the System\'s IP Address',
+    description='IPSpot: Retrieve IPv4/IPv6 Addresses with Geolocation Data',
     long_description=read_description(),
     long_description_content_type='text/markdown',
     include_package_data=True,
     author='IPSpot Development Team',
     author_email='ipspot@openscilab.com',
     url='https://github.com/openscilab/ipspot',
     download_url='https://github.com/openscilab/ipspot/tarball/v0.7',
-    keywords="ip ipv4 geo geolocation network location ipspot cli",
+    keywords="ip ipv4 ipv6 geo geolocation network location ipspot cli",
     project_urls={
         'Source': 'https://github.com/openscilab/ipspot'
     },