diff --git a/README.md b/README.md index c2a5c23..5cae1a7 100644 --- a/README.md +++ b/README.md @@ -65,17 +65,18 @@ services: **Environment Variables:** -| Variable | Description | Possible Values | Default Value | -|---------------------|-------------------------------------------------|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------| -| `DISCORD_WEBHOOK_URL` | Your Discord webhook URL | A valid URL | | -| `PRODUCT_NAMES` | The exact GPU names you're searching for | `RTX 5080, RTX 5090` | | -| `DISCORD_ROLE>` | List of Discord roles ID in the same order than `PRODUCT_NAMES` values, found in your discord server settings (with user profile developer mode enabled) | `<@&12345><@&6789>` | @everyone | -| `REFRESH_TIME` | Script refresh interval in seconds | `60`, `30`, etc. | `30` | -| `API_URL_SKU` | API listing the product | A URL. API url can change over time. For now, you can use the default one and change the `locale` parameter to yours (for exemple : `locale=en-gb`) | `https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia` | -| `API_URL_STOCK` | API providing stock data | A URL. API url can change over time. For now, you can use the default one and change the `locale` parameter to yours (for exemple : `locale=en-gb`) | `https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=` | -| `PRODUCT_URL` | GPU purchase URL | A URL. API url can change over time. For now, you can use the default one and change the `locale` parameter to yours (for exemple : `/en-gb/`) | `https://marketplace.nvidia.com/fr-fr/consumer/graphics-cards/?locale=fr-fr&page=1&limit=12&manufacturer=NVIDIA` | -| `TEST_MODE` | For testing without sending notifications | `True`, `False` | `False` | -| `PYTHONUNBUFFERED` | Enables real-time log output | `1`, `0` | `1` | +|| Variable | Description | Possible Values | Default Value | +|----------------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------| +| `DISCORD_WEBHOOK_URL`| Your Discord webhook URL | A valid URL | *(required)* | +| `PRODUCT_NAMES` | The exact GPU names you're searching for | `RTX 5080, RTX 5090` | *(required)* | +| `DISCORD_ROLES` | Discord role mentions, in the same order as `PRODUCT_NAMES`. Use IDs from your server (Dev Mode enabled). | `<@&12345>, <@&6789>`, `@everyone` | `@everyone` | +| `REFRESH_TIME` | Script refresh interval (in seconds) | `60`, `30`, etc. | `30` | +| `API_URL_SKU` | API endpoint listing the product SKUs | URL with locale, e.g. `locale=en-gb` | `https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia` | +| `API_URL_STOCK` | API endpoint providing stock data | URL with locale, e.g. `locale=en-gb` | `https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=` | +| `PRODUCT_URL` | URL to the product page | Any NVIDIA store/marketplace URL | `https://marketplace.nvidia.com/fr-fr/consumer/graphics-cards/?locale=fr-fr&page=1&limit=12&manufacturer=NVIDIA` | +| `TEST_MODE` | Run the bot without sending real notifications | `True`, `False` | `False` | +| `PYTHONUNBUFFERED` | Enables real-time logging output in Docker and terminals | `1`, `0` | `1` | + **Run the image**