Skip to content

Commit 9d25313

Browse files
committed
Update README
1 parent 1184ac7 commit 9d25313

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# ToyVPN PcapPlusPlus
22

3+
## Table of Contents
4+
5+
- [Overview](#overview-️)
6+
- [Features](#features-)
7+
- [Using the App](#using-the-app-)
8+
- [Technical Details](#technical-details-)
9+
- [Main Components](#main-components-)
10+
- [Application Flows](#application-flows-)
11+
- [License](#license-)
12+
313
## Overview 🛠️
414

515
ToyVPN PcapPlusPlus is an Android application designed for monitoring and analyzing network traffic on an Android device.
@@ -40,7 +50,7 @@ In order to run the app you need to first build and run the server which needs t
4050
a separate Linux machine (see instructions [here](server/README.md#building-the-project-️)).
4151
Then you can run the app
4252

43-
https://github.com/user-attachments/assets/e53a8f15-b8a0-4d3d-9836-8a0f2861a0b9
53+
https://github.com/user-attachments/assets/82a2b9b1-85b5-420e-aa88-88ef54bdc77f
4454

4555
The app connects to the VPN server, which then routes traffic to the internet. To use the app:
4656
1. **Set up the VPN server** on a separate Linux machine (see [server setup instructions](server/README.md#building-the-project-️)).
@@ -144,3 +154,6 @@ The following diagrams illustrate the core workflows of the app:
144154
<img src="docs/ForwardNetworkTraffic.svg"/>
145155

146156
<img src="docs/Disconnect.svg"/>
157+
158+
## License 📜
159+
This project is licensed under the **MIT License**.

docs/toyvpn-demo.mp4

1.46 MB
Binary file not shown.

0 commit comments

Comments
 (0)