Skip to content

Commit 4cc80e0

Browse files
complete the readme in more detail
1 parent 3a01021 commit 4cc80e0

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,34 @@
2020
-i or --ip string
2121
ip to send the request to (default is automatically resolved from the url)
2222
```
23+
24+
## Introduction
25+
26+
Layer7Benchmark is a tool to benchmark the performance of Layer 7 (application layer) protocols, such as HTTP and HTTPS. It allows you to test the response time and throughput of your web applications under different load conditions.
27+
28+
It is designed to be simple and easy to use, making it suitable for both developers and system administrators who want to ensure their applications can handle the expected traffic.
29+
30+
DO NOT USE THIS TOOL FOR MALICIOUS PURPOSES. IT IS INTENDED FOR LEGITIMATE PERFORMANCE TESTING ONLY. USING THIS TOOL TO ATTACK OR DISRUPT WEBSITES (such as DDOS) WITHOUT PERMISSION IS ILLEGAL AND UNETHICAL.
31+
32+
I am not responsible for any misuse of this tool. Please use it responsibly and ethically.
33+
34+
## Features
35+
36+
This tool is completely written in Rust and is designed to be fast and efficient. It uses the `reqwest` library for making HTTP and HTTPS requests, and the `tokio` library for asynchronous programming.
37+
So it is extreamly fast and efficient. Much lower CPU usage than other tools like [webbenchmark](https://github.com/maintell/webBenchmark).
38+
39+
## 中文说明
40+
41+
### 简介
42+
43+
Layer7Benchmark 是一个用于基准测试 Layer 7(应用层)协议(如 HTTP 和 HTTPS)性能的工具。它允许您在不同负载条件下测试 Web 应用程序的响应时间和吞吐量。
44+
它旨在简单易用,适合开发人员和系统管理员,确保其应用程序可以处理预期的流量。
45+
它完全用 Rust 编写,旨在快速高效。它使用 `reqwest` 库进行 HTTP 和 HTTPS 请求,并使用 `tokio` 库进行异步编程。
46+
因此,它非常快速高效。比其他工具(如 [webbenchmark](https://github.com/maintell/webBenchmark))的 CPU 使用率低得多。
47+
48+
* 不要使用这个工具进行恶意目的。它仅用于合法的性能测试。未经许可使用此工具攻击或破坏网站(例如 DDOS)是非法和不道德的。
49+
* 我不对此工具的任何误用负责。请负责任和道德地使用它。
50+
51+
## License
52+
53+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

src/args.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use clap::Parser;
1+
use clap::{Parser, ArgAction};
22

33
#[derive(Parser, Debug)]
44
pub struct Args {
@@ -13,4 +13,13 @@ pub struct Args {
1313

1414
#[arg(short='i',long="ip", default_value = "")]
1515
pub ip: String,
16+
17+
#[arg(short = 'h', long = "help", action = ArgAction::Help)]
18+
pub help: bool,
19+
20+
#[arg(short = 'v', long = "version", action = ArgAction::Version)]
21+
pub version: bool,
22+
23+
#[arg(long = "header", default_value = "")]
24+
pub header: String,
1625
}

0 commit comments

Comments
 (0)