readme and other details

montumodi · Mar 19, 2021 · 9f7bef0 · 9f7bef0
1 parent 74bd7b1
commit 9f7bef0
Show file tree

Hide file tree

Showing 5 changed files with 103 additions and 2,023 deletions.
diff --git a/Heart Rate Monitor Flatline-SoundBible.com-2063567528.mp3 b/Heart Rate Monitor Flatline-SoundBible.com-2063567528.mp3
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# Playstation 5 Stock Finder
+
+This little repo has code which hits websites which sells ps5 and alert you whenever there is a stock available. It is easy to add your own provider. Just follow the structure in one of the providers. At the moment it supports
+
+- Amazon
+- AO
+- Argos
+- Asda
+- eBuyer
+- Game
+- Johnlewos
+- Very
+
+It can alert you in two ways
+
+- Play sound. Add the mp3 of your choice and change `playSound.js` OR
+- Send text -> audio command to your google home. Use `sendToGoogleHome.js` and call `run(googleHomeIP, "The text you want to broadcast")` in `index.js`. Make sure the code and google home is running on the same network.
+
+## How to install
+
+```
+npm install ps5-stock-finder
+```
+
+## Runing
+
+```
+node index.js
+```