Skip to content

Commit 2dbc2b1

Browse files
committed
Update README.md
1 parent b5734b4 commit 2dbc2b1

File tree

1 file changed

+55
-42
lines changed

1 file changed

+55
-42
lines changed

README.md

Lines changed: 55 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,81 @@
1-
# 📶 Internet Speed Test App
1+
# Internet Speed Test App 🌐⚡
22

3-
A simple and lightweight Internet Speed Test application written in **Python**. This tool allows you to test your internet speed via **Command Line Interface (CLI)** or a user-friendly **Graphical User Interface (GUI)**.
3+
![GitHub release](https://img.shields.io/github/release/LELIONTRIBAL0/InternetSpeedTestApp.svg) ![License](https://img.shields.io/badge/license-MIT-blue.svg)
44

5-
---
5+
Welcome to the **Internet Speed Test App**! This application provides a quick, simple, and open-source way to check your internet performance. Unlike online browser-based tools, this app gives you direct access to vital metrics such as download and upload speeds, ping (latency), ISP and external IP address, and a link to share your Speedtest.net results.
66

7-
## 📸 Screenshots
7+
## Table of Contents
88

9-
### 🖥️ GUI Version
10-
![image](https://github.com/user-attachments/assets/ac39cf42-b6ba-4061-b2e9-c3994d4f3f89)
9+
- [Features](#features)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Technologies Used](#technologies-used)
13+
- [Contributing](#contributing)
14+
- [License](#license)
15+
- [Contact](#contact)
1116

17+
## Features
1218

13-
---
19+
The **Internet Speed Test App** includes the following features:
1420

15-
## 🚀 Features
21+
- **Download Speed**: Measure how fast data can be downloaded from the internet.
22+
- **Upload Speed**: Check how quickly data can be sent to the internet.
23+
- **Ping (Latency)**: Determine the response time of your internet connection.
24+
- **ISP Information**: Get details about your Internet Service Provider.
25+
- **External IP Address**: Find out your public IP address.
26+
- **Result Sharing**: Easily share your Speedtest.net results with a link.
1627

17-
- ✅ Download & Upload speed test
18-
- ✅ Ping (latency) measurement
19-
- ✅ Best server selection
20-
- ✅ ISP and IP address detection
21-
- ✅ CLI & GUI modes
22-
- ✅ Shareable result link
28+
## Installation
2329

24-
---
25-
![Screenshot 2025-05-15 112841](https://github.com/user-attachments/assets/1c1fd4fd-507a-42c5-b413-cd34734e36b3)
30+
To install the **Internet Speed Test App**, follow these steps:
2631

32+
1. **Download the latest release** from [here](https://github.com/LELIONTRIBAL0/InternetSpeedTestApp/releases). Make sure to choose the appropriate version for your operating system.
33+
2. **Extract the files** if necessary.
34+
3. **Run the application** by executing the main script in your terminal or command prompt.
2735

28-
## 📁 Folder Structure
36+
## Usage
2937

38+
Once you have installed the app, you can start testing your internet speed.
3039

31-
InternetSpeedTestApp/
32-
├── speed_test_cli.py # CLI-based speed test script
33-
├── speed_test_gui.py # GUI-based speed test using Tkinter
34-
├── requirements.txt # Required Python libraries
35-
└── README.md # This documentation file
40+
1. **Open the application**: Launch the app from your terminal or command prompt.
41+
2. **Select the test type**: Choose whether you want to measure download speed, upload speed, or ping.
42+
3. **View your results**: The app will display your internet performance metrics clearly.
43+
4. **Share your results**: Use the provided link to share your Speedtest.net results with friends or colleagues.
3644

37-
yaml
38-
Copy
39-
Edit
45+
For more details, refer to the [Releases](https://github.com/LELIONTRIBAL0/InternetSpeedTestApp/releases) section.
4046

41-
---
47+
## Technologies Used
4248

43-
## 📦 Installation
49+
The **Internet Speed Test App** is built using the following technologies:
4450

45-
Install Python packages using pip:
51+
- **Python**: The primary programming language used for development.
52+
- **Requests**: A library for making HTTP requests to gather data.
53+
- **Socket**: Used for network connections and operations.
54+
- **Speedtest-cli**: A command-line interface for testing internet speed.
55+
- **Modular Design**: The app follows a modular design for easy updates and enhancements.
4656

57+
## Contributing
4758

48-
pip install -r requirements.txt
49-
python speed_test_cli.py
50-
It will output:
59+
We welcome contributions to improve the **Internet Speed Test App**! If you want to contribute, please follow these steps:
5160

52-
Download Speed
61+
1. **Fork the repository**: Click the "Fork" button at the top right of this page.
62+
2. **Create a new branch**: Use a descriptive name for your branch.
63+
3. **Make your changes**: Implement your features or fixes.
64+
4. **Submit a pull request**: Describe your changes and why they are needed.
5365

54-
Upload Speed
66+
## License
5567

56-
Ping
68+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
5769

58-
IP Address
70+
## Contact
5971

60-
ISP
72+
For questions or suggestions, feel free to reach out:
6173

62-
Speedtest result URL
63-
![image](https://github.com/user-attachments/assets/ac39cf42-b6ba-4061-b2e9-c3994d4f3f89)
64-
python speed_test_gui.py
65-
```bash
66-
📃 License
67-
This project is licensed under the MIT License. You are free to use, modify, and distribute it.
74+
- **GitHub**: [LELIONTRIBAL0](https://github.com/LELIONTRIBAL0)
75+
- **Email**: [your_email@example.com](mailto:your_email@example.com)
6876

77+
## Conclusion
78+
79+
The **Internet Speed Test App** offers a straightforward way to measure your internet performance. With its easy-to-use interface and essential features, it stands out as a reliable tool for anyone looking to assess their connection speed. Download the latest version from the [Releases](https://github.com/LELIONTRIBAL0/InternetSpeedTestApp/releases) section and start testing today!
80+
81+
Feel free to explore, contribute, and enhance this open-source project!

0 commit comments

Comments
 (0)