add readme

This commit is contained in:
zu1k
2020-08-13 08:50:09 +08:00
parent cc61798fdf
commit abb65edfb2
2 changed files with 64 additions and 0 deletions

64
README.md Normal file
View File

@@ -0,0 +1,64 @@
<h1 align="center">
<br>proxypool<br>
</h1>
<h5 align="center">自动抓取tg频道、订阅地址、公开互联网上的ss、ssr、vmess节点信息聚合去重后提供clash配置</h5>
<p align="center">
<a href="https://github.com/zu1k/proxypool/actions">
<img src="https://img.shields.io/github/workflow/status/zu1k/proxypool/Go?style=flat-square" alt="Github Actions">
</a>
<a href="https://goreportcard.com/report/github.com/zu1k/proxypool">
<img src="https://goreportcard.com/badge/github.com/zu1k/proxypool?style=flat-square">
</a>
<a href="https://github.com/zu1k/proxypool/releases">
<img src="https://img.shields.io/github/release/zu1k/proxypool/all.svg?style=flat-square">
</a>
</p>
## 支持
- 支持ss、ssr、vmess节点链接与订阅
- 任意 Telegram 频道抓取
- 机场订阅地址抓取解析
- 公开互联网页面模糊抓取
- 翻墙党论坛新节点信息
- 其他节点分享网站
- 定时抓取更新
- 使用配置文件提供抓取源
## 安装
### 从源码编译
需要安装Golang
```sh
$ go get -u -v github.com/zu1k/proxypool
```
### 下载预编译程序
从这里下载预编译好的程序 [release](https://github.com/zu1k/proxypool/releases)
### 使用docker
```sh
docker pull docker.pkg.github.com/zu1k/proxypool/proxypool:latest
```
## 使用共享抓取配置文件
每一次抓取前会自动从github下载最新的抓取配置文件
直接运行 `proxypool` 程序即可
### 自定义抓取配置文件
```shell
proxypool -c source.yaml
```
## 截图
![测速](docs/run.png)

BIN
docs/run.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB