Remove Replit and Analytics sections from README
- Removed Replit section (not applicable for this fork) - Removed Analytics section (will be reworked to reduce resource usage) - Updated table of contents numbering - Kept settings references to enable_analytics for now
This commit is contained in:
41
README.md
41
README.md
@@ -28,7 +28,6 @@ Read more about Twitch Drops [here](https://help.twitch.tv/s/article/mission-bas
|
||||
- [Docker](#docker)
|
||||
- [Docker Hub](#docker-hub)
|
||||
- [Portainer](#portainer)
|
||||
- [Replit](#replit)
|
||||
- [Limits](#limits)
|
||||
5. 🔧 [Settings](#settings)
|
||||
- [LoggerSettings](#loggersettings)
|
||||
@@ -37,11 +36,10 @@ Read more about Twitch Drops [here](https://help.twitch.tv/s/article/mission-bas
|
||||
- [Bet strategy](#bet-strategy)
|
||||
- [FilterCondition](#filtercondition)
|
||||
- [Example](#example)
|
||||
6. 📈 [Analytics](#analytics)
|
||||
7. 🍪 [Migrating from an old repository (the original one)](#migrating-from-an-old-repository-the-original-one)
|
||||
8. 🪟 [Windows](#windows)
|
||||
9. 📱 [Termux](#termux)
|
||||
10. ⚠️ [Disclaimer](#disclaimer)
|
||||
6. 🍪 [Migrating from an old repository (the original one)](#migrating-from-an-old-repository-the-original-one)
|
||||
7. 🪟 [Windows](#windows)
|
||||
8. 📱 [Termux](#termux)
|
||||
9. ⚠️ [Disclaimer](#disclaimer)
|
||||
|
||||
|
||||
## Community
|
||||
@@ -398,12 +396,6 @@ docker run --name user2 -v $(pwd)/user2.py:/usr/src/app/run.py:ro -p 5002:5000 r
|
||||
|
||||
[Link](https://github.com/rdavydov/Twitch-Channel-Points-Miner-v2/wiki/Deploy-Docker-container-in-Portainer) to the illustrated guide on how to deploy a Docker container in Portainer.
|
||||
|
||||
### Replit
|
||||
|
||||
Official Repl: https://replit.com/@rdavydov/Twitch-Channel-Points-Miner-v2
|
||||
|
||||
Provided "as is" with no support. Testing purposes only. Updates may be delayed.
|
||||
|
||||
### Limits
|
||||
_**Twitch has a limit - you can't watch more than two channels at one time. We take the first two streamers from the list as they have the highest priority.**_
|
||||
|
||||
@@ -639,31 +631,6 @@ Here's a concrete example. Let's suppose we have a bet that is opened with a tim
|
||||
- **FROM_END** with `delay=20`: The bet will be placed 20s before the end of the bet (so 9mins 40s after the bet is opened)
|
||||
- **PERCENTAGE** with `delay=0.2`: The bet will be placed when the timer went down by 20% (so 2mins after the bet is opened)
|
||||
|
||||
## Analytics
|
||||
We have recently introduced a little frontend where you can show with a chart you points trend. The script will spawn a Flask web-server on your machine where you can select binding address and port.
|
||||
The chart provides some annotation to handle the prediction and watch strike events. Usually annotation are used to notice big increase / decrease of points. If you want to can disable annotations.
|
||||
On each (x, y) points Its present a tooltip that show points, date time and reason of points gained / lost. This web page was just a funny idea, and it is not intended to use for a professional usage.
|
||||
If you want you can toggle the dark theme with the dedicated checkbox.
|
||||
|
||||
| Light theme | Dark theme |
|
||||
| ----------- | ---------- |
|
||||
|  |  |
|
||||
|
||||
For use this feature just call the `analytics()` method before start mining. Read more at: [#96](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/96)
|
||||
The chart will be autofreshed each `refresh` minutes. If you want to connect from one to second machine that have that webpanel you have to use `0.0.0.0` instead of `127.0.0.1`. With the `days_ago` arg you can select how many days you want to show by default in your analytics graph.
|
||||
```python
|
||||
from TwitchChannelPointsMiner import TwitchChannelPointsMiner
|
||||
twitch_miner = TwitchChannelPointsMiner("your-twitch-username")
|
||||
twitch_miner.analytics(host="127.0.0.1", port=5000, refresh=5, days_ago=7) # Analytics web-server
|
||||
twitch_miner.mine(followers=True, blacklist=["user1", "user2"])
|
||||
```
|
||||
|
||||
### `enable_analytics` option in `twitch_minerfile` toggles Analytics needed for the `analytics()` method
|
||||
|
||||
Disabling Analytics significantly reduces memory consumption and saves some disk space by not creating and writing `/analytics/*.json`.
|
||||
|
||||
Set this option to `True` if you need Analytics. Otherwise set this option to `False` (default value).
|
||||
|
||||
## Migrating from an old repository (the original one):
|
||||
If you already have a `twitch-cookies.pkl` and you don't want to log in again, please create a `cookies/` folder in the current directory and then copy the .pkl file with a new name `your-twitch-username.pkl`
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user