hex/wstunnel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Former-commit-id: b4ac29f7ddd498ede43a8e9c1ec3dca1779c0844 [formerly bd59751c4c6781f58d558c99b7f08c1c266702d1] [formerly c10737ed45c14c6656e3c5752a55741051341eda [formerly 23feef7f5124ac69f69f75cff4968d06521df027]]
Former-commit-id: 3d6ef64cc603f485b01ce0cf4b876ba9865408f0 [formerly 2414f9c0b8ac7b8cce11a6516449ffe1f5a5e445]
Former-commit-id: 7f021c83d03c1886942bd9c7c51140072f5caaaf
Former-commit-id: 705b1032cf918ceb7e6c78fb849286a04bfee9a7
Former-commit-id: 5963a941b431f6d20497127414e842a3f6ca448c
Former-commit-id: d2664edf1e605b65d6aa0a39447261c5f8ee3fd8 [formerly c956016b48c982aee5efe81f400714076d7af938]
Former-commit-id: 0873f3324519e53ed7665058e018a29875385dca
This commit is contained in:
Erèbe - Romain Gerard 2023-10-21 15:53:48 +02:00 committed by GitHub
parent 092ef29d7f
commit 11df46c136
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -3,6 +3,8 @@
<img src="https://github.com/erebe/wstunnel/raw/main/logo_wstunnel.png" alt="wstunnel logo"/>
</p>
## Description
Most of the time when you are using a public network, you are behind some kind of firewall or proxy. One of their purpose is to constrain you to only use certain kind of protocols. Nowadays, the most widespread protocol is http and is de facto allowed by third party equipment.
@ -24,6 +26,19 @@ My inspiration came from [this project](https://www.npmjs.com/package/wstunnel)
P.S: Please do not pay attention to Main.hs because as I hate to write command line code this file is crappy
## Note
V7.0.0 is a complete rewrite of wstunnel in Rust.
Previous code in Haskell can be found on branch https://github.com/erebe/wstunnel/tree/haskell
What to expect from previous version:
* More throughput and less jitter due to Haskell GC. Most of you will not care, as it was performant enough already. But you can now saturate a gigabit ethernet card with a single connection
* Command line is more homogeneous/has better UX. All tunnel can be specified multiple times
* New bug, it is a rewrite (╯'□')╯︵ ┻━┻ ¯\\_(ツ)_/¯
* Mainly for me to ease the maintenance of the project. I don't do a lot of haskell nowadays and it was harder for me to keep maintening the project over time, as I get lost in touch of the Haskell ecosystem and new release.
* Armv7 build (aka raspberry pi), as new version of GHC (Haskell compiler) dropped its support
## Command line
```