diff --git a/README.md b/README.md index 383b9bacf..f893efb07 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ ehco is a network relay tool and a typo :) +[see Readme in English here](README_EN.md) + ## 视频安装教程 本隧道和 [django-sspanel](https://github.com/Ehco1996/django-sspanel)深度对接,可以很方便的管理中转节点 diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 000000000..d381b5f02 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,23 @@ +# Ehco + +ehco is a network relay tool and a typo :) + +[![Go Report Card](https://goreportcard.com/badge/github.com/Ehco1996/ehco)](https://goreportcard.com/report/github.com/Ehco1996/ehco) +[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/Ehco1996/ehco) +[![Docker Pulls](https://img.shields.io/docker/pulls/ehco1996/ehco)](https://hub.docker.com/r/ehco1996/ehco) + +## Quick Start + +let's see some examples + +> relay all tcp traffic from `0.0.0.0:1234` to `0.0.0.0:5201` + +`ehco -l 0.0.0.0:1234 -r 0.0.0.0:5201` + +> also relay udp traffic to `0.0.0.0:5201` + +`ehco -l 0.0.0.0:1234 -r 0.0.0.0:5201 -ur 0.0.0.0:5201` + +## Advance Usage + +TBD, for now, you can see more examples in [ReadmeCN](README.md)