diff --git a/.editorconfig b/.editorconfig index dc7f786..07a3ad5 100644 --- a/.editorconfig +++ b/.editorconfig @@ -7,6 +7,6 @@ charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true -[*.{yml, json.md}] +[*.{yml, json, md}] indent_style = space indent_size = 2 diff --git a/README.md b/README.md index 92b85f4..81c7950 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ -# nvidia-snatcher [![ci](https://github.com/jef/nvidia-snatcher/workflows/ci/badge.svg)](https://github.com/jef/nvidia-snatcher/actions?query=workflow%3Aci) [![chat on freenode](https://img.shields.io/badge/chat-on%20freenode-blue)](https://kiwiirc.com/nextclient/irc.kiwiirc.com/?nick=kiwi_?#streetmerchant) +
+
streetmerchant +

streetmerchant

+The world's easiest, most powerful stock checker +

+ +Tweet +Tweet +

+FAQ | +Issues | +Wiki +

+ +
-[FAQ](#FAQ) | [Issues](https://github.com/jef/nvidia-snatcher/issues) -| [Wiki](https://github.com/jef/nvidia-snatcher/wiki) +## Features -![nvidia-snatcher](media/screenshot.png) - -The purpose of this bot is to get an Nvidia card. It tries multiple things to do that. - -- Currently, `nvidia-snatcher` is not capable of purchasing a card for you -- Scrapes multiple websites for patterns of being stocked - - API requests are a work in progress (very soon) +- Scrapes multiple websites for patterns of being stocked via API and Chromium - Opens browser when stock is available - Ability to send notifications when stock is available +> :point_right: The bot _will not_ automatically buy for you + ## Installation overview Linux, macOS, and Windows are all capable operating systems. @@ -29,7 +38,7 @@ getting `nvidia-snatcher` running! - Run `npm install` - Copy `.env-example` to a new file `.env` and edit the `.env` file to your liking using your [favorite text editor](https://code.visualstudio.com/) - - More on this in [customization](#Customization) + - More on this in [customization](#Customization) - Run `npm run start` to start At any point you want the program to stop, use Ctrl + C. @@ -437,7 +446,8 @@ this [wiki page](https://github.com/jef/nvidia-snatcher/wiki/Troubleshoot:-Gener **Q: Why don't my notifications work?** There is probably an [issue](https://github.com/jef/nvidia-snatcher/issues?q=is%3Aissue+sort%3Aupdated-desc+sound+is%3Aclosed) that -has [already](https://github.com/jef/nvidia-snatcher/issues/182) [been](https://github.com/jef/nvidia-snatcher/issues/116) [resolved](https://github.com/jef/nvidia-snatcher/issues/155). +has [already](https://github.com/jef/nvidia-snatcher/issues/182) [been](https://github.com/jef/nvidia-snatcher/issues/116) [resolved](https://github.com/jef/nvidia-snatcher/issues/155) +. **Q: I'd love to contribute, how do I do that?** Make a [pull request](https://github.com/jef/nvidia-snatcher/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)! All diff --git a/media/screenshot.png b/media/screenshot.png deleted file mode 100644 index d7dd554..0000000 Binary files a/media/screenshot.png and /dev/null differ diff --git a/media/streetmerchant-square.png b/media/streetmerchant-square.png new file mode 100644 index 0000000..09b32bc Binary files /dev/null and b/media/streetmerchant-square.png differ diff --git a/media/streetmerchant.png b/media/streetmerchant.png new file mode 100644 index 0000000..6112857 Binary files /dev/null and b/media/streetmerchant.png differ diff --git a/media/terminal.gif b/media/terminal.gif new file mode 100644 index 0000000..ea30de6 Binary files /dev/null and b/media/terminal.gif differ