github/StreamingCommunity
1
1
Fork 0
mirror of https://github.com/Arrowar/StreamingCommunity.git synced 2025-06-05 02:55:25 +00:00
Code Issues 2 Packages Projects Releases Wiki Activity

doc: Update readme

Browse Source
This commit is contained in:
Lovi 2025-03-22 12:30:08 +01:00
parent e864855dd5
commit a087bf0c28
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -60,18 +60,20 @@
# Installation # Installation
<p align="center"> <p align="center">
<a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_win.exe" style="margin: 0 20px;"> <a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_win.exe">
<img src="https://img.shields.io/badge/-Windows-blue.svg?style=for-the-badge&logo=windows" alt="Windows"> <img src="https://img.shields.io/badge/-Windows-blue.svg?style=for-the-badge&logo=windows" alt="Windows">
</a> </a>
<a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_mac" style="margin: 0 20px;"> <a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_mac">
<img src="https://img.shields.io/badge/-macOS-black.svg?style=for-the-badge&logo=apple" alt="macOS"> <img src="https://img.shields.io/badge/-macOS-black.svg?style=for-the-badge&logo=apple" alt="macOS">
</a> </a>
<a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_linux" style="margin: 0 20px;"> <a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_linux">
<img src="https://img.shields.io/badge/-Linux-orange.svg?style=for-the-badge&logo=linux" alt="Linux"> <img src="https://img.shields.io/badge/-Linux-orange.svg?style=for-the-badge&logo=linux" alt="Linux">
</a> </a>
<a href="https://github.com/Arrowar/StreamingCommunity/releases/latest/download/StreamingCommunity_linux_previous">
<img src="https://img.shields.io/badge/-Linux Previous-gray.svg?style=for-the-badge&logo=linux" alt="Linux Previous">
</a>
</p> </p>
## 1. PyPI Installation ## 1. PyPI Installation
Install directly from PyPI: Install directly from PyPI:
@ -349,7 +351,9 @@ The configuration file is divided into several main sections:
"show_trending": true, "show_trending": true,
"use_api": true, "use_api": true,
"not_close": false, "not_close": false,
"telegram_bot": false "telegram_bot": false,
"download_site_data": false,
"validate_github_config": false
} }
} }
``` ```
@ -362,6 +366,8 @@ The configuration file is divided into several main sections:
- `not_close`: If set to true, keeps the program running after download is complete - `not_close`: If set to true, keeps the program running after download is complete
* Can be changed from terminal with `--not_close true/false` * Can be changed from terminal with `--not_close true/false`
- `telegram_bot`: Enables Telegram bot integration - `telegram_bot`: Enables Telegram bot integration
- `download_site_data`: If set to false, disables automatic site data download
- `validate_github_config`: If set to false, disables validation and updating of configuration from GitHub
## OUT_FOLDER Settings ## OUT_FOLDER Settings

4
config.json
View File

@ -6,7 +6,9 @@
"show_trending": true, "show_trending": true,
"use_api": true, "use_api": true,
"not_close": false, "not_close": false,
"telegram_bot": false "telegram_bot": false,
"download_site_data": true,
"validate_github_config": true
}, },
"OUT_FOLDER": { "OUT_FOLDER": {
"root_path": "Video", "root_path": "Video",