Merge branch 'develop'

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
           elif [[ $result ]]; then
               echo "Release body generated."
           else
-              echo "This is the first release, useing different command to generate release body."
+              echo "This is the first release, using different command to generate release body."
               npx rexreplace "(#+ \[?\d+\.\d+\.\d+]?.*)" "_" -s -M -G -m -o "CHANGELOG.md" > RELEASE_BODY.md
           fi
       - name: Create release

README.md

@@ -24,6 +24,12 @@ This script can be used in 2 ways:
 
 ## How it works?
 
+#### What does this script different from the others?
+
+Most of the script found uses for loop to spam clicks or keyboard events, which eats up a lot of resources. This script has **optimized the performance** to run check every 1 seconds, and hooks into Popcat's Vue instances to alter counter status only after "Pops" have been sent to server.
+
+This script also embeds "Metadata Block", which allows the script to be installed via Tampermonkey. Once the script is installed, you don't need to copy and paste every time, and the bot will automatically run when [https://popcat.click](https://popcat.click) page is load.
+
 #### Why is it 799 "Pops" every 30 seconds? Can I adjust the script to send more "Pops"?
 
 It is not recommended to send "Pops" more then 799 every 30 seconds due to Popcat's logic.
@@ -32,6 +38,8 @@ Popcats sends accumlated clicks to it's server every 30 second. On every request
 
 Also, for accumlated clicks more than 800, the value will clamped to 800 before sending to server. So the maximum contribution to leaderboard per 30 seconds will be 800 only.
 
+Note that the cool down time for the server API is 30 seconds. If a same IP address tries to send multiple requests within 30 seconds, the server will returns `429 - Too many requests`. It is recommend to make sure there is no other browser tabs running [https://popcat.click](https://popcat.click) when using this bot.
+
 Here is the source code of Popcat as of 15 August, 2021.
 ![Popcat source code](docs/images/bot-logic.png)
 

popcat-bot.user.js

@@ -7,9 +7,9 @@
 // @match        https://popcat.click/
 // @icon         https://www.google.com/s2/favicons?domain=popcat.click
 // @grant        none
-// @updateURL    https://github.com/icelam/popcat-bot/raw/master/tampermonkey.js
+// @updateURL    https://raw.githubusercontent.com/icelam/popcat-bot/master/popcat-bot.user.js
 
-// @downloadURL  https://raw.githubusercontent.com/icelam/popcat-bot/master/tampermonkey.js
+// @downloadURL  https://raw.githubusercontent.com/icelam/popcat-bot/master/popcat-bot.user.js
 // @supportURL   https://github.com/icelam/popcat-bot/issues
 // ==/UserScript==