Skip to content

Commit 3863952

Browse files
committed
Adding README notes
1 parent 0b3ce6f commit 3863952

File tree

5 files changed

+40
-1
lines changed

5 files changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# ProtobuffedDrogon
1+
<h1 align="center"> ProtobuffedDrogon </h1>
2+
3+
> A simple implementation of protobuf in drogon framework.
4+
5+
- Also, you can write by opening an Issue and also solve a current issue if possible.
6+
- Fork this project to your Github account.
7+
- This software is created under [MIT License](https://github.com/MuriloChianfa/ProtobuffedDrogon/blob/main/LICENSE)
8+
9+
<hr>
10+
11+
## Running the project
12+
13+
- Download docker images or build them:
14+
```bash
15+
docker-compose pull || docker-compose build
16+
```
17+
18+
- Run environment
19+
```bash
20+
docker-compose up -d
21+
```
22+
23+
- Access website to connect with drogon websocket: http://127.0.0.1/
24+
- You'll receive traffic updates from your interfaces every 1 second (bps and pps).
25+
26+
## Testing example:
27+
28+
Downloading Debian 11 iso image with wget.
29+
30+
> Use --report-speed=bits to gets the bitrate metrics
31+
32+
![Alt text](images/bitrate-captured.png)
33+
![Alt text](images/packetrate-captured.png)
34+
![Alt text](images/bitrate.png)
35+
36+
## Protobuf packets sented throught websocket to website:
37+
38+
> The minimal throuput as possible.
39+
40+
![Alt text](images/protobuf.png)

images/bitrate-captured.png

21.9 KB
Loading

images/bitrate.png

57.4 KB
Loading

images/packetrate-captured.png

21.7 KB
Loading

images/protobuf.png

36.6 KB
Loading

0 commit comments

Comments
 (0)