updated readme

Author: sergioteula

README.md

@@ -1,131 +1,129 @@
-# Amazon Product Advertising API 5.0 wrapper for Python
+# Python Amazon PAAPI
 
-A simple Python wrapper for the [last version of the Amazon Product Advertising
-API](https://webservices.amazon.com/paapi5/documentation/quick-start/using-sdk.html).
-This module allows interacting with Amazon using the official API in an easier way.
+A simple Python wrapper for the [Amazon Product Advertising API 5.0](https://webservices.amazon.com/paapi5/documentation/). Easily interact with Amazon's official API to retrieve product information, search for items, and more.
 
 [![PyPI](https://img.shields.io/pypi/v/python-amazon-paapi?color=%231182C2&label=PyPI)](https://pypi.org/project/python-amazon-paapi/)
-[![Python](https://img.shields.io/badge/Python->3.9-%23FFD140)](https://www.python.org/)
+[![Python](https://img.shields.io/badge/Python-≥3.9-%23FFD140)](https://www.python.org/)
 [![License](https://img.shields.io/badge/License-MIT-%23e83633)](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE)
 [![Amazon API](https://img.shields.io/badge/Amazon%20API-5.0-%23FD9B15)](https://webservices.amazon.com/paapi5/documentation/)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/python-amazon-paapi?label=Installs)](https://pypi.org/project/python-amazon-paapi/)
+[![Downloads](https://img.shields.io/pypi/dm/python-amazon-paapi?label=Downloads)](https://pypi.org/project/python-amazon-paapi/)
 
 ## Features
 
-- Object oriented interface for simple usage.
-- Get information about a product through its ASIN or URL.
-- Get item variations or search for products on Amazon.
-- Get browse nodes information.
-- Get multiple results at once without the 10 items limitation from Amazon.
-- Configurable throttling to avoid requests exceptions.
-- Type hints to help you coding.
-- Support for [all available countries](https://github.com/sergioteula/python-amazon-paapi/blob/956f639b2ab3eab3f61644ae2ca8ae6500881312/amazon_paapi/models/regions.py#L1).
-- Ask for new features through the [issues](https://github.com/sergioteula/python-amazon-paapi/issues) section.
-- Join our [Telegram group](https://t.me/PythonAmazonPAAPI) for support or development.
-- Check the [documentation](https://python-amazon-paapi.readthedocs.io/en/latest/index.html) for reference.
-- See the [changelog](https://github.com/sergioteula/python-amazon-paapi/blob/master/CHANGELOG.md) for version history.
+- 🎯 **Simple object-oriented interface** for easy integration
+- 🔍 **Product search** by keywords, categories, or browse nodes
+- 📦 **Product details** via ASIN or Amazon URL
+- 🔄 **Item variations** support (size, color, etc.)
+- 🌍 **20+ countries** supported ([full list](https://github.com/sergioteula/python-amazon-paapi/blob/master/amazon_paapi/models/regions.py))
+- ⚡ **Batch requests** to get multiple items without the 10-item limit
+- 🛡️ **Built-in throttling** to avoid API rate limits
+- 📝 **Full type hints** for better IDE support
 
 ## Installation
 
-You can install or upgrade the module with:
-
-    pip install python-amazon-paapi --upgrade
-
-## Usage guide
+```bash
+pip install python-amazon-paapi --upgrade
+```
 
-**Basic usage:**
+## Quick Start
 
 ```python
 from amazon_paapi import AmazonApi
+
+# Initialize the API (get credentials from Amazon Associates)
 amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY)
+
+# Get product information by ASIN
 item = amazon.get_items('B01N5IB20Q')[0]
-print(item.item_info.title.display_value) # Item title
+print(item.item_info.title.display_value)
 ```
 
-**Get multiple items information:**
+## Usage Examples
+
+### Get Multiple Products
 
 ```python
 items = amazon.get_items(['B01N5IB20Q', 'B01F9G43WU'])
 for item in items:
-    print(item.images.primary.large.url) # Primary image url
-    print(item.offers.listings[0].price.amount) # Current price
+    print(item.images.primary.large.url)
+    print(item.offers.listings[0].price.amount)
 ```
 
-**Use URL instead of ASIN:**
+### Use Amazon URL Instead of ASIN
 
 ```python
 item = amazon.get_items('https://www.amazon.com/dp/B01N5IB20Q')
 ```
 
-**Get item variations:**
+### Search Products
 
 ```python
-variations = amazon.get_variations('B01N5IB20Q')
-for item in variations.items:
-    print(item.detail_page_url) # Affiliate url
+results = amazon.search_items(keywords='nintendo switch')
+for item in results.items:
+    print(item.item_info.title.display_value)
 ```
 
-**Search items:**
+### Get Product Variations
 
 ```python
-search_result = amazon.search_items(keywords='nintendo')
-for item in search_result.items:
-    print(item.item_info.product_info.color) # Item color
+variations = amazon.get_variations('B01N5IB20Q')
+for item in variations.items:
+    print(item.detail_page_url)
 ```
 
-**Get browse node information:**
+### Get Browse Node Information
 
 ```python
-browse_nodes = amazon.get_browse_nodes(['667049031', '599385031'])
-for browse_node in browse_nodes:
-    print(browse_node.display_name) # The name of the node
+nodes = amazon.get_browse_nodes(['667049031', '599385031'])
+for node in nodes:
+    print(node.display_name)
 ```
 
-**Get the ASIN from URL:**
+### Extract ASIN from URL
 
 ```python
 from amazon_paapi import get_asin
+
 asin = get_asin('https://www.amazon.com/dp/B01N5IB20Q')
+# Returns: 'B01N5IB20Q'
 ```
 
-**Throttling:**
+### Configure Throttling
 
-Throttling value represents the wait time in seconds between API calls, being the
-default value 1 second. Use it to avoid reaching Amazon request limits.
+Control the wait time between API calls to avoid rate limits:
 
 ```python
-amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=4)  # Makes 1 request every 4 seconds
-amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=0)  # No wait time between requests
+# Wait 4 seconds between requests
+amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=4)
+
+# No throttling (use with caution)
+amazon = AmazonApi(KEY, SECRET, TAG, COUNTRY, throttling=0)
 ```
 
-## Contribution
+## Documentation
+
+- 📖 [Full Documentation](https://python-amazon-paapi.readthedocs.io/)
+- 📋 [Changelog](https://github.com/sergioteula/python-amazon-paapi/blob/master/CHANGELOG.md)
+- 💬 [Telegram Support Group](https://t.me/PythonAmazonPAAPI)
+
+## Contributing
 
-Creating pull requests for this repo is highly appreciated to add new features or solve
-bugs. To help during development process, follow these steps:
+Contributions are welcome! To get started:
 
 1. Install [uv](https://docs.astral.sh/uv/) package manager
-2. Clone the repository and install dependencies:
+2. Clone and set up the project:
 
 ```bash
 git clone https://github.com/sergioteula/python-amazon-paapi.git
 cd python-amazon-paapi
 uv sync
-```
-
-3. Set up pre-commit hooks:
-
-```bash
 uv run pre-commit install
 ```
 
-4. Copy `.env.template` to `.env` and fill in your Amazon API credentials for integration tests.
+3. Copy `.env.template` to `.env` and add your Amazon API credentials for integration tests.
 
-The pre-commit hooks will run Ruff (linting and formatting), mypy (type checking), and
-tests before each commit. The same checks will also run on the repo with GitHub Actions
-to ensure all tests pass before merge.
+Pre-commit hooks will automatically run Ruff, mypy, and tests before each commit.
 
 ## License
 
-Copyright © 2026 Sergio Abad. See
-[license](https://github.com/sergioteula/python-amazon-paapi/blob/master/LICENSE) for
-details.
+MIT License © 2026 [Sergio Abad](https://github.com/sergioteula)