Skip to content

Commit

Permalink
update:README
Browse files Browse the repository at this point in the history
  • Loading branch information
Guovin committed Dec 12, 2024
1 parent 66ec2b3 commit 75544ac
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 22 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@

- ✅ 自定义模板,生成您想要的频道
- ✅ 支持多种获取源方式:组播源、酒店源、订阅源、关键字搜索
- ✅ 接口测速验效,响应时间、分辨率优先级,过滤无效接口
- ✅ 接口测速验效,获取延迟、速率、分辨率,过滤无效接口
- ✅ 偏好设置:IPv6、接口来源排序优先级与数量配置、接口白名单
- ✅ 定时执行,北京时间每日 6:00 与 18:00 执行更新
- ✅ 支持多种运行方式:工作流、命令行、GUI 软件、Docker(amd64/arm64/arm v7)
Expand Down Expand Up @@ -139,23 +139,30 @@ Fork 本项目并开启工作流更新,具体步骤请见[详细教程](./docs
### 方式二:命令行

```python
pip install pipenv
pip
install
pipenv
```

```python
pipenv install --dev
pipenv
install - -dev
```

启动更新:

```python
pipenv run dev
pipenv
run
dev
```

启动服务:

```python
pipenv run service
pipenv
run
service
```

### 方式三:GUI 软件
Expand All @@ -165,14 +172,17 @@ pipenv run service
2. 或者在项目目录下运行以下命令,即可打开 GUI 软件:

```python
pipenv run ui
pipenv
run
ui
```

<img src="./docs/images/ui.png" alt="IPTV-API更新软件" title="IPTV-API更新软件" style="height:600px" />

### 方式四:Docker

- iptv-api(完整版本):性能要求较高,更新速度较慢,稳定性、成功率高;修改配置 open_driver = False 可切换到 Lite 版本运行模式(推荐酒店源、组播源、关键字搜索使用此版本)
- iptv-api(完整版本):性能要求较高,更新速度较慢,稳定性、成功率高;修改配置 open_driver = False 可切换到 Lite
版本运行模式(推荐酒店源、组播源、关键字搜索使用此版本)
- iptv-api:lite(精简版本):轻量级,性能要求低,更新速度快,稳定性不确定(推荐订阅源使用此版本)

1. 拉取镜像:
Expand Down Expand Up @@ -236,8 +246,8 @@ docker run -v /etc/docker/config:/iptv-api-lite/config -v /etc/docker/output:/ip

<div>开发维护不易,请我喝杯咖啡☕️吧~</div>

| 支付宝 | 微信 |
| ----------------------------------------- | ------------------------------------------- |
| 支付宝 | 微信 |
|--------------------------------------|-----------------------------------------|
| ![支付宝扫码](./static/images/alipay.jpg) | ![微信扫码](./static/images/appreciate.jpg) |

## 关注
Expand Down
42 changes: 29 additions & 13 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@

- ✅ Customize the template to generate the channel you want
- ✅ Supports multiple source acquisition methods: multicast source, hotel source, subscription source, keyword search
- ✅ Interface speed testing and verification, with priority on response time and resolution, filtering out ineffective interfaces
- ✅ Interface speed verification, obtain delay, speed, resolution, filter invalid interface
- ✅ Preferences: IPv6, priority and quantity of interface source sorting, and interface whitelist
- ✅ Scheduled execution at 6:00 AM and 18:00 PM Beijing time daily
- ✅ Supports various execution methods: workflows, command line, GUI software, Docker(amd64/arm64/arm v7)
Expand Down Expand Up @@ -134,46 +134,60 @@ https://ghp.ci/raw.githubusercontent.com/Guovin/iptv-api/gd/source.json

### Method 1: Workflow

Fork this project and initiate workflow updates, detailed steps are available at [Detailed Tutorial](./docs/tutorial_en.md)
Fork this project and initiate workflow updates, detailed steps are available
at [Detailed Tutorial](./docs/tutorial_en.md)

### Method 2: Command Line

```python
pip install pipenv
pip
install
pipenv
```

```python
pipenv install --dev
pipenv
install - -dev
```

Start update:

```python
pipenv run dev
pipenv
run
dev
```

Start service:

```python
pipenv run service
pipenv
run
service
```

### Method 3: GUI Software

1. Download [IPTV-API update software](https://github.com/Guovin/iptv-api/releases), open the software, click update to complete the update
1. Download [IPTV-API update software](https://github.com/Guovin/iptv-api/releases), open the software, click update to
complete the update

2. Or run the following command in the project directory to open the GUI software:

```python
pipenv run ui
pipenv
run
ui
```

<img src="./docs/images/ui.png" alt="IPTV-API update software" title="IPTV-API update software" style="height:600px" />

### Method 4: Docker

- iptv-api (Full version): Higher performance requirements, slower update speed, high stability and success rate. Set open_driver = False to switch to the lite running mode (recommended for hotel sources, multicast sources, and online searches)
- iptv-api:lite (Condensed version): Lightweight, low performance requirements, fast update speed, stability uncertain (recommend using this version for the subscription source)
- iptv-api (Full version): Higher performance requirements, slower update speed, high stability and success rate. Set
open_driver = False to switch to the lite running mode (recommended for hotel sources, multicast sources, and online
searches)
- iptv-api:lite (Condensed version): Lightweight, low performance requirements, fast update speed, stability uncertain (
recommend using this version for the subscription source)

It's recommended to try each one and choose the version that suits you

Expand Down Expand Up @@ -206,7 +220,8 @@ docker run -d -p 8000:8000 guovern/iptv-api:lite
```

Volume Mount Parameter (Optional):
This allows synchronization of files between the host machine and the container. Modifying templates, configurations, and retrieving updated result files can be directly operated in the host machine's folder.
This allows synchronization of files between the host machine and the container. Modifying templates, configurations,
and retrieving updated result files can be directly operated in the host machine's folder.

Taking the host path /etc/docker as an example:

Expand Down Expand Up @@ -239,7 +254,7 @@ docker run -v /etc/docker/config:/iptv-api-lite/config -v /etc/docker/output:/ip
<div>Development and maintenance are not easy, please buy me a coffee ~</div>

| Alipay | Wechat |
| ------------------------------------- | ----------------------------------------- |
|---------------------------------------|-------------------------------------------|
| ![Alipay](./static/images/alipay.jpg) | ![Wechat](./static/images/appreciate.jpg) |

## Follow
Expand All @@ -250,7 +265,8 @@ Wechat public account search for Govin, or scan the code to receive updates and

## Disclaimer

This project is for learning and communication purposes only. All interface data comes from the internet. If there is any infringement, please contact us for removal.
This project is for learning and communication purposes only. All interface data comes from the internet. If there is
any infringement, please contact us for removal.

## License

Expand Down

0 comments on commit 75544ac

Please sign in to comment.