Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jelipo committed Feb 15, 2021
1 parent f620598 commit d3f269a
Showing 1 changed file with 42 additions and 7 deletions.
49 changes: 42 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,47 @@
# Touch the world
## What's this
A proxy tool implemented by rust.
## Status
**IN PROCESSING...**
## Build
You need a rust build environment.
```shell
cargo build --release
```
## How to use
1. Creat a new config file `config.json`.
Such as:
```json
{
"input": {
"name": "socks5",
"config": {
"local_host": "127.0.0.1",
"local_port": 1080
}
},
"output": {
"name": "ss-aes-256-gcm",
"config": {
"remote_host": "127.0.0.1",
"remote_port": 3391
}
}
}
```
2. Make sure you use this directory structure.
```
(root dir)
β”œ--config
| β””--config.json
β””--touch-rust.exe / touch-rust
```
3. run `./touch-rust`

- [x] Socks5 support
- [x] Shadowsocks AEAD support
- [ ] HTTP proxy support
- [ ] UDP support
- [ ] More Encrypt support
## Status
| protocol |support|
| :---: | :---: |
| SOCKS5 | βœ… |
| Shadowsocks AEAD | βœ… |
| HTTP proxy support | ❌ |
| UDP support | ❌ |
| More protocol support...|Coming soon...|

0 comments on commit d3f269a

Please sign in to comment.