Skip to content

Commit d1ee80d

Browse files
authored
Update the readme (#10)
- Add the Jenkins build badge - Remove Syncthing Relay support mention - Update flags
1 parent f93f1f6 commit d1ee80d

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
*An application protocol multiplexer*
44

5+
[![Build Status](https://jenkins-pandentia.qcx.io/job/Cassandra/job/protoplex/job/mistress/badge/icon)](https://jenkins-pandentia.qcx.io/job/Cassandra/job/protoplex/job/mistress/)
6+
57
## What is this?
68

79
In a nutshell, this application lets you run multiple kinds of applications
@@ -13,21 +15,21 @@ firewalls that block all other outbound ports.
1315

1416
### Native
1517

16-
Compile the multiplexer with
18+
Assuming you have a properly configured Go setup, get and compile the multiplexer with
1719

1820
```bash
19-
go build protoplex.go
21+
go get github.com/Pandentia/protoplex/cmd/protoplex
2022
```
2123

2224
and then run it with (for example, to run SSH and HTTPS)
2325

2426
```bash
25-
./protoplex -ssh your_ssh_host:22 -tls your_webserver:443
27+
protoplex --ssh your_ssh_host:22 --tls your_webserver:443
2628
```
2729

2830
Protoplex is now running on port `8443` and ready to accept connections.
2931

30-
For more extensive configuration, please see the output of `-help`.
32+
For more extensive configuration, please see the output of `--help`.
3133

3234
### Docker
3335

@@ -60,7 +62,6 @@ Currently supported protocols are:
6062
- TLS (/ HTTPS)
6163
- OpenVPN
6264
- SOCKS4 / SOCKS5
63-
- Syncthing Relay (untested, hypothetical)
6465

6566
Feel free to [file an issue](https://github.com/Pandentia/protoplex/issues/new)
6667
on the GitHub repository if you want a protocol to be supported. Please include

0 commit comments

Comments
 (0)