Skip to content

Commit

Permalink
doc: add simple readme en
Browse files Browse the repository at this point in the history
  • Loading branch information
Ehco1996 committed Apr 16, 2022
1 parent a9b4ecc commit d00fba9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)深度对接,可以很方便的管理中转节点
Expand Down
23 changes: 23 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit d00fba9

Please sign in to comment.