Skip to content

Commit 3fb13d1

Browse files
Update README.md
1 parent a303e46 commit 3fb13d1

File tree

1 file changed

+32
-18
lines changed

1 file changed

+32
-18
lines changed

README.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@
33

44
Vector-Rat is a powerful, efficient, and flexible remote access tool designed to provide an easy-to-use platform for managing and controlling remote devices. Built with scalability and performance in mind, it supports various functionalities for remote control, file management, and system monitoring.
55

6+
![Vector-Rat Demo](images/vector-rat.webp)
7+
68
## Features
79

810
- **Remote Access**: Gain control of remote machines with ease.
9-
- **File Management**: Transfer files to/from remote machines.
11+
- **File Management**: Transfer files to and from remote machines.
1012
- **System Monitoring**: Track system resources, running processes, and more.
11-
- **Real-Time Interaction**: Execute commands and interact with the remote system.
12-
- **Cross-Platform**: Works on various platforms, including Windows, macOS, and Linux.
13-
- **Encryption**: Secure communication between client and server with encryption protocols.
13+
- **Real-Time Interaction**: Execute commands and interact with the remote system in real time.
14+
- **Cross-Platform**: Compatible with various platforms, including Windows, macOS, and Linux.
15+
- **Encryption**: Secure communication between client and server using encryption protocols.
1416

1517
## Installation
1618

@@ -40,23 +42,23 @@ Vector-Rat is a powerful, efficient, and flexible remote access tool designed to
4042

4143
### Starting the Server
4244

43-
To start the server, use the following command:
45+
To start the server, run the following command:
4446

4547
```bash
4648
python server.py
4749
```
4850

49-
This will launch the server, and it will wait for incoming connections from clients.
51+
The server will now be running and waiting for incoming connections from clients.
5052

5153
### Starting the Client
5254

53-
To start the client, use the following command:
55+
To start the client, run the following command:
5456

5557
```bash
5658
python client.py
5759
```
5860

59-
Ensure the client connects to the correct server IP address and port.
61+
Make sure the client connects to the correct server IP address and port.
6062

6163
## Configuration
6264

@@ -71,27 +73,39 @@ You can configure various settings in the `config.py` file, such as:
7173
We welcome contributions! If you'd like to contribute, please follow these steps:
7274
7375
1. Fork the repository.
74-
2. Create a new branch (`git checkout -b feature-branch`).
75-
3. Commit your changes (`git commit -am 'Add new feature'`).
76-
4. Push to the branch (`git push origin feature-branch`).
76+
2. Create a new branch:
77+
```bash
78+
git checkout -b feature-branch
79+
```
80+
3. Commit your changes:
81+
```bash
82+
git commit -am 'Add new feature'
83+
```
84+
4. Push to your branch:
85+
```bash
86+
git push origin feature-branch
87+
```
7788
5. Create a new Pull Request.
7889
79-
Please ensure that your contributions follow the code style of the project and include appropriate tests where possible.
90+
Please ensure your contributions follow the project's code style and include appropriate tests where possible.
8091

8192
## License
8293

83-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
94+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
8495

8596
## Acknowledgements
8697

8798
- Thanks to [OpenSSL](https://www.openssl.org/) for providing robust encryption support.
88-
- Inspiration and code references from various open-source projects.
99+
- Special thanks to contributors from various open-source projects for their inspiration and code references.
89100

90101
---
91102

92103
For more information or questions, feel free to open an issue on GitHub.
93-
```
94104

95-
### Notes:
96-
- You should replace certain details like the server and client commands with the specific commands used in your project.
97-
- Make sure that the sections, such as configuration, match the actual structure of your codebase (e.g., which files need to be configured).
105+
106+
107+
108+
109+
110+
111+

0 commit comments

Comments
 (0)