Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rdavydov authored Oct 23, 2022
1 parent da8215b commit a411ed3
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ twitch_miner = TwitchChannelPointsMiner(
Priority.DROPS, # - When we don't have anymore watch streak to catch, wait until all drops are collected over the streamers
Priority.ORDER # - When we have all of the drops claimed and no watch-streak available, use the order priority (POINTS_ASCENDING, POINTS_DESCEDING)
],
analytics=False, # Disables Analytics if False. Disabling it significantly reduces memory consumption
logger_settings=LoggerSettings(
save=True, # If you want to save logs in a file (suggested)
console_level=logging.INFO, # Level of logs - use logging.DEBUG for more info
Expand Down Expand Up @@ -586,14 +587,11 @@ twitch_miner.analytics(host="127.0.0.1", port=5000, refresh=5, days_ago=7) # A
twitch_miner.mine(followers=True, blacklist=["user1", "user2"])
```

### `ENABLE_ANALYTICS.py` file in the main directory toggles Analytics
### `analytics` option in `twitch_minerfile` toggles Analytics

Disabling Analytics significantly reduces memory consumption and saves some disk space.
Disabling Analytics significantly reduces memory consumption and saves some disk space by not creating and writing `/analytics/*.json`.

- Remove this file if you don't need Analytics. Or rename it to something different, like `DISABLE_ANALYTICS.py`.
- To enable Analytics back - just create this file again. Or rename it back to `ENABLE_ANALYTICS.py`.

This file can be empty.
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`
Expand Down

0 comments on commit a411ed3

Please sign in to comment.