docs: list cleanups, unnecessary bolding, etc

Signed-off-by: Jef LeCompte <jeffreylec@gmail.com>
This commit is contained in:
Jef LeCompte
2020-09-30 12:04:47 -04:00
parent 9e7976df57
commit f980a0bba0
2 changed files with 24 additions and 24 deletions
+10 -10
View File
@@ -3,6 +3,7 @@
############################################################################################# #############################################################################################
BROWSER_TRUSTED="" BROWSER_TRUSTED=""
COUNTRY=""
DISCORD_NOTIFY_GROUP="" DISCORD_NOTIFY_GROUP=""
DISCORD_WEB_HOOK="" DISCORD_WEB_HOOK=""
EMAIL_USERNAME="" EMAIL_USERNAME=""
@@ -16,28 +17,27 @@ MICROCENTER_LOCATION=""
NVIDIA_ADD_TO_CART_ATTEMPTS="" NVIDIA_ADD_TO_CART_ATTEMPTS=""
NVIDIA_SESSION_TTL="" NVIDIA_SESSION_TTL=""
OPEN_BROWSER="" OPEN_BROWSER=""
PAGE_TIMEOUT=""
PHONE_NUMBER=""
PHONE_CARRIER=""
PLAY_SOUND=""
PUSHBULLET=""
PUSHOVER_TOKEN=""
PUSHOVER_USER=""
PUSHOVER_PRIORITY=""
PAGE_BACKOFF_MIN="" PAGE_BACKOFF_MIN=""
PAGE_BACKOFF_MAX="" PAGE_BACKOFF_MAX=""
PAGE_SLEEP_MIN="" PAGE_SLEEP_MIN=""
PAGE_SLEEP_MAX="" PAGE_SLEEP_MAX=""
PAGE_TIMEOUT=""
PHONE_NUMBER=""
PHONE_CARRIER=""
PLAY_SOUND=""
PROXY_ADDRESS="" PROXY_ADDRESS=""
PROXY_PORT="" PROXY_PORT=""
PUSHBULLET=""
PUSHOVER_TOKEN=""
PUSHOVER_USER=""
PUSHOVER_PRIORITY=""
SCREENSHOT="false"
SHOW_ONLY_BRANDS="" SHOW_ONLY_BRANDS=""
SHOW_ONLY_MODELS="" SHOW_ONLY_MODELS=""
SHOW_ONLY_SERIES="" SHOW_ONLY_SERIES=""
SLACK_CHANNEL="" SLACK_CHANNEL=""
SLACK_TOKEN="" SLACK_TOKEN=""
STORES="" STORES=""
COUNTRY=""
SCREENSHOT="false"
TELEGRAM_ACCESS_TOKEN="" TELEGRAM_ACCESS_TOKEN=""
TELEGRAM_CHAT_ID="" TELEGRAM_CHAT_ID=""
TWILIO_ACCOUNT_SID="" TWILIO_ACCOUNT_SID=""
+14 -14
View File
@@ -30,7 +30,7 @@ The purpose of this bot is to get an Nvidia card. It tries multiple things to do
> :point_right: You may get false positives from time to time, so I apologize for that. The library currently waits for all calls to be completed before parsing, but sometimes this can have unknown behavior. Patience is a virtue :) > :point_right: You may get false positives from time to time, so I apologize for that. The library currently waits for all calls to be completed before parsing, but sometimes this can have unknown behavior. Patience is a virtue :)
| | **Adorama** | **Amazon** | **Amazon (CA)** | **ASUS** | **B&H** | **Best Buy** | **Best Buy (CA)** | **EVGA** | **Micro Center** | **Newegg** | **Newegg (CA)** | **Nvidia** | **Office Depot** | **PNY** | **Zotac** | | | Adorama | Amazon | Amazon (CA) | ASUS | B&H | Best Buy | Best Buy (CA) | EVGA | Micro Center | Newegg | Newegg (CA) | Nvidia | Office Depot | PNY | Zotac |
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:| |:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| **3070**| | | | | | | | | | | | | | `✔` | | | **3070**| | | | | | | | | | | | | | `✔` | |
| **3080** | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | | **3080** | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` | `✔` |
@@ -66,7 +66,7 @@ To customize `nvidia-snatcher`, make a copy of `.env-example` as `.env` and make
Here is a list of variables that you can use to customize your newly copied `.env` file: Here is a list of variables that you can use to customize your newly copied `.env` file:
| **Environment variable** | **Description** | **Notes** | | Environment variable | Description | Notes |
|:---:|---|---| |:---:|---|---|
| `BROWSER_TRUSTED` | Skip Chromium Sandbox | Useful for containerized environments, default: `false` | | `BROWSER_TRUSTED` | Skip Chromium Sandbox | Useful for containerized environments, default: `false` |
| `DESKTOP_NOTIFICATIONS` | Display desktop notifications using [node-notifier](https://www.npmjs.com/package/node-notifier) | Default: `false` | | `DESKTOP_NOTIFICATIONS` | Display desktop notifications using [node-notifier](https://www.npmjs.com/package/node-notifier) | Default: `false` |
@@ -112,12 +112,12 @@ Here is a list of variables that you can use to customize your newly copied `.en
| `TWILIO_AUTH_TOKEN` | Twilio Auth Token | Can be found on twilio.com/console | | `TWILIO_AUTH_TOKEN` | Twilio Auth Token | Can be found on twilio.com/console |
| `TWILIO_FROM_NUMBER` | Twilio provided phone number to send messages from | Include country code e.g +4401234567890 | | `TWILIO_FROM_NUMBER` | Twilio provided phone number to send messages from | Include country code e.g +4401234567890 |
| `TWILIO_TO_NUMBER` | Mobile number to send SMS to | Include country code e.g +4401234567890 | | `TWILIO_TO_NUMBER` | Mobile number to send SMS to | Include country code e.g +4401234567890 |
| `USER_AGENT` | Custom User-Agent header for HTTP requests | Default: `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36` |
| `TWITTER_CONSUMER_KEY` | Twitter Consumer Key | Generate all Twitter keys at: https://developer.twitter.com/ | | `TWITTER_CONSUMER_KEY` | Twitter Consumer Key | Generate all Twitter keys at: https://developer.twitter.com/ |
| `TWITTER_CONSUMER_SECRET` | Twitter Consumer Secret | | | `TWITTER_CONSUMER_SECRET` | Twitter Consumer Secret | |
| `TWITTER_ACCESS_TOKEN_KEY` | Twitter Token Key | | | `TWITTER_ACCESS_TOKEN_KEY` | Twitter Token Key | |
| `TWITTER_ACCESS_TOKEN_SECRET` | Twitter Token Secret | | | `TWITTER_ACCESS_TOKEN_SECRET` | Twitter Token Secret | |
| `TWITTER_TWEET_TAGS` | Optional list of hashtags to append to the tweet message | E.g.: `#nvidia #nvidiastock` | | `TWITTER_TWEET_TAGS` | Optional list of hashtags to append to the tweet message | E.g.: `#nvidia #nvidiastock` |
| `USER_AGENT` | Custom User-Agent header for HTTP requests | Default: `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36` |
> :point_right: If you have multi-factor authentication (MFA), you will need to create an [app password](https://myaccount.google.com/apppasswords) and use this instead of your Gmail password. > :point_right: If you have multi-factor authentication (MFA), you will need to create an [app password](https://myaccount.google.com/apppasswords) and use this instead of your Gmail password.
@@ -153,7 +153,7 @@ Here is a list of variables that you can use to customize your newly copied `.en
<details> <details>
<summary>Micro Center stores</summary> <summary>Micro Center stores</summary>
| **Store name** | | Store name |
|:---:| |:---:|
| `brooklyn` | | `brooklyn` |
| `brentwood` | | `brentwood` |
@@ -185,19 +185,19 @@ Here is a list of variables that you can use to customize your newly copied `.en
#### Supported Brands and Models #### Supported Brands and Models
| **Brand** | **Model** | | Brand | Model |
|:---:|---| |:---:|---|
| asus | rog strix, rog strix oc, strix, tuf, tuf oc | | `asus` | `rog strix`, `rog strix oc`, `strix`, `tuf`, `tuf oc` |
| evga | ftw3, ftw3 ultra, xc3 black, xc3, xc3 ultra | | `evga` | `ftw3`, `ftw3 ultra`, `xc3 black`, `xc3`, `xc3 ultra` |
| gigabyte | eagle, eagle oc, gaming, gaming oc | | `gigabyte` | `eagle`, `eagle oc`, `gaming`, `gaming oc` |
| msi | gaming x trio, ventus 3x, ventus 3x oc | | `msi` | `gaming x trio`, `ventus 3x`, `ventus 3x oc` |
| nvidia | founders edition | | `nvidia` | `founders edition` |
| pny | dual fan, xlr8, xlr8 rgb | | `pny` | `dual fan`, `xlr8`, `xlr8 rgb` |
| zotac | trinity, trinity oc | | `zotac` | `trinity`, `trinity oc` |
#### Supported carriers #### Supported carriers
| **Carrier** | **Environment variable** | **Notes** | | Carrier | Environment variable | Notes |
|:---:|:---:|:---:| |:---:|:---:|:---:|
| AT&T | `att`| | | AT&T | `att`| |
| Bell | `bell` | | | Bell | `bell` | |
@@ -217,7 +217,7 @@ Here is a list of variables that you can use to customize your newly copied `.en
`COUNTRY` is only used by the `nvidia` and `nvidia-api` stores. `COUNTRY` is only used by the `nvidia` and `nvidia-api` stores.
| **Country** | **3080 FE** | **3090 FE** | **Test Card** | **Notes** | | Country | 3080 FE | 3090 FE | Test Card | Notes |
|:---:|:---:|:---:|:---:|:---:| |:---:|:---:|:---:|:---:|:---:|
| austria | `✔` | `✔` | `✔` | | | austria | `✔` | `✔` | `✔` | |
| belgium | `✔` | `✔` | `✔` | | | belgium | `✔` | `✔` | `✔` | |